latestSwagger 2.02026-08-08454367651.1 KB

bd42075f6b02

ResourceOwnerWorkOrder

Retrieve a list of work orders and their containing attachments, items and notes

If no time is set on the "to" parameter, then it's assumed all entries on the date should be included, and the time part will be set to 11:59:59 PM

get/v1/resourceowner/workorders

Query parameters

fromstring date-time

Filter on JobDate to be on or after the specified date and time (default is from now)

tostring date-time

Filter on JobDate to be before the specified date and time (default is no limitation)

jobStatus0 | 1 | 2 | 3 | 4 | 5 | 6

Status on job (New = 0, Started = 1, Paused = 2, Completed = 3, Cancelled = 4, Invoiced = 5, Paid = 6) (default is all)

includeUnassignedboolean

Include unassigned jobs (default is true)

includeDeletedboolean

Include deleted jobs (default is false)

Response

Successful request

JobDatestring date-time
EstimatedTimeInMinutesinteger
JobDescriptionstring
ExternalIdstring
CustomerContactNamestring
CustomerEmailstring
CustomerNamestring
CustomerCommunicationLanguageISO639_2string
CustomerPhoneNumberstring
NotificationType0 | 1 | 2 | 3
WorkOrderCategoryIdinteger
CategoryNamestring
AssignedToContactIdinteger
QuoteIdinteger
WorkOrderCustomerIdinteger
Status0 | 1 | 2 | 3 | 4 | 5 | 6
WorkOrderIdinteger
Createdstring date-time
IsDeletedboolean
Ratingnumber double
RequestedByContactIdinteger