Installer.com DocsGET
List your orders, newest first. Filter by displayId (the job id shown in the app), externalId, idempotencyKey or email to find an order by a reference you hold, or page through all orders with cursor to match them on your side. Keep the same filters while paging. Unknown query parameters are rejected. Test orders are left out.
Bearerheader
AuthorizationBearer <token>Installer.com auth token
displayId?stringCase-insensitive match on the job id shown in the app
Length
1 <= lengthexternalId?stringLength
1 <= lengthidempotencyKey?stringThe idempotency key sent when the order was created
Length
1 <= lengthemail?stringCase-insensitive match on the customer email
Length
1 <= lengthupdatedAfter?stringOnly orders updated at or after this time. Use it to sync changes since your last poll.
Format
date-timelimit?integerRange
1 <= value <= 100Default
25cursor?stringnextCursor from the previous page
Length
1 <= lengthPage of orders
application/json- response
values*array<>nextCursor*|Pass as cursor to get the next page. Null on the last page.
Example Request
curl -X GET 'https://api.installer.com/api/v1/order'Example Response
{ "values": [ { "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" } ], "nextCursor": "string"}