Installer.com DocsGet one order by its id. To look up an order by the job id shown in the app or by your own reference, use List Orders with a filter.
BearerAuthorizationBearer <token>Installer.com auth token
orderId*stringuuidOrder
application/json- response
id*stringuuiddisplayId*stringJob id shown in the app, e.g. P1-123
externalId*|Your own reference for the order, set on create or PATCH. Not unique.
name*stringdescription*|Plain text order description
status*stringLifecycle of the order: open (PENDING), CANCELLED or DONE. Progress through the workflow is in the workflow field. New values may be added; treat unknown values as opaque.
"PENDING""CANCELLED""DONE"source*stringHow the order was created. New values may be added; treat unknown values as opaque.
"API""MANUAL""FORM""TYPEFORM""WIDGET""WEBFORM"isTest*booleanCreated to try out a workflow. Left out of List Orders.
contactPersonName*stringemail*stringphoneNumber*stringaddress*stringpostalCode*stringcity*stringstate*string|nullcountryCode*stringtags*array<>customFields*Custom field values keyed by customId
metadata*|nullworkflow?Read-only progress. Only returned by Get Order.
createdAt*stringdate-timeupdatedAt*stringChanges when the order's own fields change. Workflow progress does not change it yet.
date-timeclosedAt*|date-timecurl -X GET 'https://api.installer.com/api/v1/order/497f6eca-6276-4993-bfeb-53cbbbba6f08'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "displayId": "string", "externalId": "string", "name": "string", "description": "string", "status": "PENDING", "source": "API", "isTest": true, "contactPersonName": "string", "email": "string", "phoneNumber": "string", "address": "string", "postalCode": "string", "city": "string", "state": "string", "countryCode": "string", "tags": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "color": "string", "date": "string" } ], "customFields": { "property1": "string", "property2": "string" }, "metadata": { "property1": null, "property2": null }, "workflow": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "templateId": "196100ac-4eec-4fb6-a7f7-86c8b584771d", "templateCustomId": "string", "templateName": "string", "templateVersion": 0, "actors": [ { "slug": "string", "name": "string", "organization": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "externalId": "string" } } ], "steps": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "templateStepId": "2a465857-77fb-4953-99f7-90a658d82eec", "title": "string", "type": "booking_create", "status": "todo", "completedAt": "2019-08-24T14:15:22Z", "actorSlug": "string", "assignee": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "email": "string" } } ] }, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "closedAt": "2019-08-24T14:15:22Z"}