workOrders

Get Work Order

Retrieve a specific work order by ID.

The lineItems property is returned only for service work orders on an account (parent project type ACCOUNT), and only when at least one line item exists. Otherwise the field is omitted from the JSON object.

get/work-orders/{work_order_id}

Request

  • Base URL: https://api.coperniq.io/v1
  • URL: https://api.coperniq.io/v1/work-orders/{work_order_id}
  • Auth: API key in header x-api-key

Path parameters

work_order_idinteger required

Work order identifier

Response

Work order details

idinteger

Work order identifier

uidinteger

Unique work order number within the project

templateIdinteger

Template identifier for the work order

createdAtstring date-time

Creation timestamp

updatedAtstring date-time

Last update timestamp

titlestring

Work order title

descriptionstring

Work order description

priorityinteger

Priority level

startDatestring date-time nullable

Scheduled start date

startDateAllDayboolean

Whether the start date is an all-day event

endDatestring date-time nullable

Scheduled end date

endDateAllDayboolean

Whether the end date is an all-day event

completedAtstring date-time nullable

Timestamp when the work order was completed

isActiveboolean

Whether the work order is active (not archived)

isArchivedboolean

Deprecated: use isActive instead. Kept for backward compatibility.

isCompletedboolean

Whether the work order is completed

isFieldboolean

Whether the work order is a field task

Changes

No recorded changes to this operation across all 1 revision of this API.