Skip to navigation
API ReferenceWork Orders

List Account Work Orders

Retrieve work orders for a specific account.

Supports:

  • Pagination (page_size, page)
  • Date filtering (updated_after, updated_before)
  • Sorting (order_by)
  • Archived work orders (include_archived=true, case-insensitive; any other value is treated as false, so archived work orders are excluded by default)

Work orders whose parent project, opportunity, or account is archived are never returned, even with include_archived=true.

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

Authentication

x-api-keystring
API Key authentication via header

Path parameters

account_idintegerRequired
Account identifier

Query parameters

page_sizeintegerOptional1-100Defaults to 20

Number of items per page (max 100)

pageintegerOptional>=1Defaults to 1

Page number (1-based)

updated_afterstringOptional

Filter items updated after this timestamp (ISO 8601). Also matches records whose custom property values changed within the window.

updated_beforestringOptional

Filter items updated before this timestamp (ISO 8601). Also matches records whose custom property values changed within the window.

order_byenumOptionalDefaults to asc
Sort order for results
Allowed values:
include_archivedbooleanOptionalDefaults to false

Whether to include archived (inactive) records in the response. By default only active records are returned.

Response

List of work orders
idintegerOptional
Work order identifier
uidintegerOptional
Unique work order number within the project
templateIdintegerOptional
Template identifier for the work order
createdAtstringOptionalformat: "date-time"
Creation timestamp
updatedAtstringOptionalformat: "date-time"
Last update timestamp
titlestringOptional
Work order title
descriptionstringOptional
Work order description
priorityintegerOptional
Priority level
startDatestring or nullOptionalformat: "date-time"
Scheduled start date
startDateAllDaybooleanOptional

Whether the start date is an all-day event

endDatestring or nullOptionalformat: "date-time"
Scheduled end date
endDateAllDaybooleanOptional

Whether the end date is an all-day event

completedAtstring or nullOptionalformat: "date-time"
Timestamp when the work order was completed
isActivebooleanOptional

Whether the work order is active (not archived)

isCompletedbooleanOptional
Whether the work order is completed
isFieldbooleanOptional
Whether the work order is a field task
labelslist of objectsOptional
Labels associated with the work order
projectobjectOptional
Project associated with the work order
createdByobject or nullOptionalRead-only

User who created the work order. null when unknown. Create responses return { id } only.

assigneeobject or nullOptional
User assigned to the work order
collaboratorslist of objectsOptional
Additional users collaborating on the work order
visitsobjectOptional

Site visits associated with the work order (legacy shape)

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

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 objectsOptional

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/{work_order_id}/line-items. Omitted from the response when not applicable or when there are no line items.

isArchivedbooleanOptionalDeprecated

Deprecated: use isActive instead. Kept for backward compatibility.