Sign in
Work Order

Get a specific work order

get/api/work-orders/{workOrderId}

Path parameters

workOrderIdstring required

Response

The work order for the given id

idstring required

Unique Id associated to this entity

numberinteger required

Job number

namestring required

Job name, defaults to number unless otherwise specified.

createdUtcstring date-time

The date the job was created

completedOnUtcstring date-time nullable

The job completion datetime.

cancelledOnUtcstring date-time nullable

The job cancelled datetime.

scheduledStartUtcstring date-time nullable

The current scheduled start time.

scheduledEndUtcstring date-time nullable

The current scheduled end time.

status'needsReview' | 'approved' | 'scheduled' | 'inProgress' | 'complete' | 'cancelled' required

Work order status

priority'low' | 'moderate' | 'high'

Job priority

Changes

No recorded changes to this endpoint across all 23 revisions of this API.