API ReferenceWork Orders

List Opportunity Work Orders

Retrieve work orders for a specific opportunity

Note: The /requests path is an alias for /opportunities and will continue to work until users are individually notified and migrated.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

opportunityIdintegerRequired
Opportunity identifier

Response

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

Whether the start date is an all-day event

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

Whether the end date is an all-day event

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

Site visits associated with the work order (legacy shape)

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

Work items linked to this work order via Blueprint workflow. Includes forms (FORM) and file requests (FILE_REQUEST). Returns [] when none are linked.

lineItemslist of objects

Present only for service work orders on an account (parent project type ACCOUNT), and only when at least one line item exists. Amounts are in dollars with cent precision. Replace via PUT /work-orders/{workOrderId}/line-items. Omitted from the response when not applicable or when there are no line items.