With our community of partners, you can get expert advice and training so you can be up and running in no time! SETUP PARTNERS

This endpoint can be used to map your existing stored IDs (such as client IDs, quotes, invoices, jobs and any other such IDs) to new UUIDs. You can use it once you’re ready to begin storing UUIDs alongside your existing stored data. Once you’ve updated your stored data with the UUIDs returned from this endpoint, and you have also upgraded your API calls to store any newly created data’s UUIDs, you’ll be ready to switch over to use the V3 version exclusively.

 

Methods

GET maps

Returns list of URLs for ID-to-UUID map files


GET maps

EXAMPLE URL

https://api.workflowmax.com/uuid.api/maps?apiKey=[your API key]&accountKey=[WorkflowMax account key]

 

Example Response

<Response>

  <Status>OK</Status> 

  <Maps>

    <Map>

      <!-- See Types by API section below -->

      <Type>Job</Type>

 

      <!-- Date when the maps were last recalculated -->

      <Date>2019-05-30T00:00:00Z</Date>

 

      <!--

        Link to CSV file containing ID-UUID map.

        See Example File Format section below.

      -->

      <File>https://workflowmax-prod.s3.amazonaws.com/12345/job.csv?…</File>

      

      <!-- Expiry date for the File link -->

      <Expiry>2019-05-31T12:31:45Z</Expiry>

    </Map>

    <Map>

      <Type>Client</Type>

      <Date>2019-05-29T00:00:00</Date>

      <File>https://workflowmax-prod.s3.amazonaws.com/12345/client.csv?…</File>

      <Expiry>2019-05-31T12:31:45Z</Expiry>

    </Map>

  </Maps>

</Response>

 

ID-to-UUID mapping is provided for all entity IDs in the API (excluding IDs that are not changing, e.g. Quote ID). You can find a list of Type values in Types by API section below. If there are no entities of a certain type in the account, the <Map> entry will not be returned.

The mapping is provided as a CSV file (see format in Example File Format section below). The files are exported on a schedule (at least once per day), and are not guaranteed to contain the most recent IDs at any particular moment.

Each file link is only valid until <Expiry>. After that time, a new GET maps request is required to obtain a new link.

 

Example File Format

Note: all lines are separated by newlines using Windows newline format (\r\n).
The file always ends with a newline.

 

Most cases

ID,UUID

123451,95962730-4456-4708-a395-cec964bbb0b9

123452,829d5e3a-6100-49a5-b906-b32a5c326b28

123453,e02055b2-2e37-416a-9349-1c4c5d62032e

123454,0e314213-9ed0-46eb-89b4-a9068a055887

123455,2c482979-0eee-472c-8caf-eb11162bd670

 

Special header for some cases using InternalID (e.g Job)

InternalID,UUID

678901,7207ce87-e3c4-49d4-baaf-a59b427f13c3

678902,50d59f2b-034d-4bd1-98dd-20c3ae973e48

678903,1d5d2cdc-c53a-47a4-bc57-634e3b8447e3

678904,33ba53c7-8992-4a3a-b6e3-fb568a69a2b4

678905,c5585941-acba-4d1c-9200-30d8ac57f9c4

 

Types by API

Table below provides Type for each ID field in API v1.

As an example, to find UUID values for field Relationship ID returned by client.api, you need to find <Map> with <Type>ClientRelationship</Type>.

API

ID Field

<Type> for ID-UUID Map

category.api

Category/ID

Category

client.api

Client/ID

Client

Group/ID

ClientGroup

Relationship/ID

ClientRelationship

Contact/ID

Contact

AccountManager/ID

Staff

JobManager/ID

Staff

clientgroup.api

Client/ID

Client

Group/ID

ClientGroup

cost.api

Cost/ID

Cost

Supplier/ID

Supplier

customfield.api

CustomFieldDefinition/ID

CustomFieldDefinition

CustomField/ID

CustomFieldDefinition

invoice.api

Invoice/InternalID

Invoice

Task/ID

InvoiceTask

Client/ID

Client

Contact/ID

Contact

job.api

Job/InternalID

Job

Category/ID

JobCategory

Cost/ID

JobCost

Task/ID

JobTask

Task/TaskID

Task

Client/ID

Client

Manager/ID

Staff

Partner/ID

Staff

Staff/ID

Staff

Supplier/ID

Supplier

TemplateID

Template

jobstate.api

JobState/ID

JobState

lead.api

Lead/ID

Lead

Category/ID

LeadCategory

Client/ID

Client

Contact/ID

Contact

Owner/ID

Staff

Responsible/ID

Staff

purchaseorder.api

Supplier/ID

Supplier

quote.api

Client/ID

Client

Contact/ID

Contact

staff.api

Staff/ID

Staff

supplier.api

Supplier/ID

Supplier

task.api

Task/ID

Task

template.api

Template/ID

Template

time.api

Time/ID

Time

Task/ID

JobTask

Task/InvoiceTaskID

InvoiceTask

Staff/ID

Staff