Sign in
latestOpenAPI 3.0.02026-08-2217901.1 MB

ef9153fcac7c

Work Orders

List work orders

Endpoint used to list work order resources

get/workorders

Query parameters

cursorstring

Last pagination reference

limitinteger

max number of Work Orders returned

titlestring

To filter work orders by title

assetsinteger[]

To filter by multiple asset IDs: assets=630&assets=634

notAssetsinteger[]

Filter work orders that have none of the provided assets. To filter by multiple asset IDs: notAssets=630&notAssets=634

locationsinteger[]

To filter by multiple location IDs: locations=193&locations=194&locations=195

notLocationsinteger[]

Filter work orders that have none of the provided locations. To filter by multiple location IDs: notLocations=193&notLocations=194&notLocations=195

partsinteger[]

To filter by multiple part IDs: parts=14677&parts=14687

notPartsinteger[]

Filter work orders that have none of the provided parts. To filter by multiple part IDs: notParts=14677&notParts=14687

vendorsinteger[]

To filter by multiple vendor IDs: vendors=7123&vendors=2234

notVendorsinteger[]

Filter work orders that have none of the provided vendors. To filter by multiple vendor IDs: notVendors=7123&notVendors=2234

assigneesinteger[]

To filter by multiple assignee IDs: assignees=23494&assignees=79808

teamsinteger[]

To filter by multiple team IDs: teams=112&teams=243

[
  "Damage"
]
[
  "Damage"
]
prioritiesstring[]

To filter by multiple priorities: priorities=LOW&priorities=MEDIUM

[
  "MEDIUM"
]
statusesstring[]

To filter by multiple statuses: statuses=IN_PROGRESS&statuses=DONE

partStatusesstring[]

To filter by multiple partStatuses: partStatuses=ASSIGNED&partStatuses=ISSUED

parentSubWorkOrderTypesstring[]

To filter by multiple parentSubWorkOrderTypes: parentSubWorkOrderTypes=PARENT&parentSubWorkOrderTypes=SUB_WORK_ORDER

show_upcomingboolean

Include work orders with a future start date

updatedAt[gte]string date-time

Return records whose updatedAt is at or after this ISO 8601 date-time (UTC).

Example:2024-01-01T00:00:00.000Z
updatedAt[lte]string date-time

Return records whose updatedAt is at or before this ISO 8601 date-time (UTC).

Example:2024-12-31T23:59:59.999Z
createdAt[gte]string date-time

Return records whose createdAt is at or after this ISO 8601 date-time (UTC).

Example:2024-01-01T00:00:00.000Z
createdAt[lte]string date-time

Return records whose createdAt is at or before this ISO 8601 date-time (UTC).

Example:2024-12-31T23:59:59.999Z
sort'updatedAt' | 'createdAt' | 'dueDate' | 'startedAt' | 'completedAt' | '-updatedAt' | '-createdAt' | '-dueDate' | '-startedAt' | '-completedAt'

Attribute on which to sort the list. (for descending order, prefix attribute with '-').

expandstring[]

To expand multiple fields: expand=thumbnail&expand=assignees

Headers

x-organization-idinteger

Required if using a multi organizations token

Response

Successfully fetched Work Orders list

nextCursorstring nullable required

The cursor to retrieve the next page of Work Orders.

nextPageUrlstring nullable required

Path with query parameters that can be used to retrieve the next page of Work Orders.

Example response

{
  "workOrders": [
    {
      "updatedAt": "2022-01-01T00:00:00.000Z",
      "completedAt": "2022-01-01T00:00:00.000Z",
      "createdAt": "2022-01-01T00:00:00.000Z",
      "customerId": 128,
      "deletedAt": "2022-01-01T00:00:00.000Z",
      "description": "A work order sample description",
      "dueDate": "2022-01-01T00:00:00.000Z",
      "lastMessageSentAt": "2022-01-01T00:00:00.000Z",
      "startDate": "2022-01-01T00:00:00.000Z",
      "locationId": 611,
      "priority": "MEDIUM",
      "recurrenceInfo": {
        "automationMeterTrigger": {
          "newDueDateOffsetSeconds": 86400
        }
      },
      "extraFields": {
        "Estimated Budget": "$250"
      },
      "vendorIds": [
        1
      ],
      "workOrderSummary": {
        "content": "Replaced the motor bearings and aligned the shaft.",
        "summary": "Motor bearing replacement and shaft alignment completed.",
        "authorId": 963
      },
      "assignees": [
        {
          "type": "USER"
        }
      ],
      "categories": [
        "Cleaning"
      ],
      "thumbnail": {
        "id": 12345,
        "mimeType": "image/png",
        "fileName": "image.png",
        "url": "http://example.com/image.png",
        "createdAt": "2022-01-01T00:00:00.000Z",
        "width": 220,
        "height": 100
      },
      "asset": {
        "id": 963,
        "name": "Forklift",
        "description": "Forklift that is used to to move heavy equipments around the warehouse",
        "parentId": 852,
        "criticalityId": 150,
        "locationId": 852,
        "serialNumber": "000123ABC",
        "createdAt": "2022-01-01T00:00:00.000Z",
        "updatedAt": "2022-01-01T00:00:00.000Z",
        "creatorId": 851
      },
      "location": {
        "id": 963,
        "name": "Warehouses",
        "description": "The warehouse where we store the forklifts",
        "address": "1090 main street, Franklin",
        "parentId": 852,
        "createdAt": "2022-01-01T00:00:00.000Z",
        "updatedAt": "2022-01-01T00:00:00.000Z"
      },
      "parts": [
        {
          "id": 963,
          "name": "Locknut - 1/8",
          "area": "tool room",
          "unitCost": 120,
          "availableQuantity": 10,
          "minimumQuantity": 5,
          "barcode": "bWFpbnRhaW54Cg==",
          "quantityUsed": 120,
          "locationId": 852
        }
      ],
      "procedure": {
        "id": 1234,
        "templateIds": [
          1234,
          1235
        ],
        "title": "Control dashboard audit",
        "maxScore": 2,
        "score": 1,
        "fields": [
          {
            "id": 1234,
            "parentId": 1233,
            "procedureTemplateId": 1234,
            "procedureTemplateFieldId": 5678,
            "description": "Number of green lights",
            "type": "NUMBER",
            "label": "Number of green lights",
            "maxScore": 2,
            "score": 1,
            "value": {
              "text": "12",
              "attachment": {
                "id": 12345,
                "mimeType": "image/png",
                "fileName": "image.png",
                "url": "http://example.com/image.png",
                "createdAt": "2022-01-01T00:00:00.000Z",
                "width": 220,
                "height": 100
              },
              "attachments": [
                {
                  "id": 12345,
                  "mimeType": "image/png",
                  "fileName": "image.png",
                  "url": "http://example.com/image.png",
                  "createdAt": "2022-01-01T00:00:00.000Z",
                  "width": 220,
                  "height": 100
                }
              ],
              "notes": {
                "text": "1 light bulb is burned out."
              }
            },
            "meter": {
              "id": 123
            }
          }
        ]
      }
    }
  ]
}