API ReferenceWork Orders

List Project Work Orders

Retrieve work orders for a specific project. Supports: - Pagination (`page_size`, `page`) - Date filtering (`updated_after`, `updated_before`) - Sorting (`order_by`)

Authentication

x-api-keystring
API Key authentication via header

Path parameters

projectIdstringRequired
Project identifier

Query parameters

page_sizeintegerOptional1-100Defaults to 20

Number of items per page (max 100)

pageintegerOptional>=1Defaults to 1

Page number (1-based)

updated_afterstringOptionalformat: "date-time"

Filter items updated after this timestamp (ISO 8601)

updated_beforestringOptionalformat: "date-time"

Filter items updated before this timestamp (ISO 8601)

order_byenumOptionalDefaults to asc
Sort order for results
Allowed values:

Response

List of work orders
idinteger or null
Work order identifier
uidinteger or null
Unique work order number within the project
templateIdinteger or null
Template identifier for the work order
createdAtstring or nullformat: "date-time"
Creation timestamp
updatedAtstring or nullformat: "date-time"
Last update timestamp
titlestring or null
Work order title
descriptionstring or null
Work order description
priorityinteger or null
Priority level
startDatestring or nullformat: "date-time"
Scheduled start date
startDateAllDayboolean or null

Whether the start date is an all-day event

endDatestring or nullformat: "date-time"
Scheduled end date
endDateAllDayboolean or null

Whether the end date is an all-day event

completedAtstring or nullformat: "date-time"
Timestamp when the work order was completed
isArchivedboolean or null
Whether the work order is archived
isCompletedboolean or null
Whether the work order is completed
isFieldboolean or null
Whether the work order is a field task
labelslist of objects or null
Labels associated with the work order
projectobject or null
Project associated with the work order
assigneeobject or null
User assigned to the work order
visitsobject or null

Site visits associated with the work order (legacy shape)

statuseslist of objects or null
History of status changes and time spent in each status
statusobject or null
Current status of the work order
checklistlist of objects or null
Checklist items for the work order

Errors