Saltar al contenido principal
GET
List work orders

Autorizaciones

X-API-KEY
string
header
requerido
OW-KEY
string
header
requerido

OpenWrench shared secret. Required on every request alongside X-API-KEY; issued together with your API key.

Parámetros de consulta

offset
integer

Number of records to skip.

Rango requerido: x >= 0
limit
integer

Page size. Default 10, maximum 25.

sort_by
string

Sort field. Supported: createdAt, locationName (alphabetical), woPriority (by the priority's expected resolution time), lastServiceCallServiceScheduledAt. Any other value falls back to createdAt descending.

order
enum<string>

Sort direction.

Opciones disponibles:
asc,
desc

Full-text search. Matches words (with prefix and stem matching) across the title, description, location name, notes, service call check-in/check-out notes, problem type name, and reference numbers (work order number, PO number, asset serial number). Wrap the value in double quotes to require the exact phrase.

id
integer

One work order by id, or several in one call (ids=9001,9002). Useful for refreshing a known batch. One value. To match several, use the plural key.

ids
string

One work order by id, or several in one call (ids=9001,9002). Useful for refreshing a known batch. Comma-separated list; matches any value listed.

status
string

The detailed workflow status, for example statuses=PendingConfirmationByServiceProvider to find work waiting for you to accept. Values are listed in the status model. This is the work order's own status, even on work sub-contracted to you. Third-party suppliers never see PendingApproval work orders. One value. To match several, use the plural key.

statuses
string

The detailed workflow status, for example statuses=PendingConfirmationByServiceProvider to find work waiting for you to accept. Values are listed in the status model. This is the work order's own status, even on work sub-contracted to you. Third-party suppliers never see PendingApproval work orders. Comma-separated list; matches any value listed.

notStatuses
string

The detailed workflow status, for example statuses=PendingConfirmationByServiceProvider to find work waiting for you to accept. Values are listed in the status model. This is the work order's own status, even on work sub-contracted to you. Third-party suppliers never see PendingApproval work orders. Comma-separated list; excludes every value listed.

displayStatus
string

The simplified status shown in the OpenWrench app: Pending, Deferred, Open, InProgress, OnHold, Completed, or Cancelled. Every detailed status maps to one of these. One value. To match several, use the plural key.

displayStatuses
string

The simplified status shown in the OpenWrench app: Pending, Deferred, Open, InProgress, OnHold, Completed, or Cancelled. Every detailed status maps to one of these. Comma-separated list; matches any value listed.

isActive
enum<string>

true returns work still in progress (display status Pending, Open, InProgress, or OnHold). false returns closed work (Completed or Cancelled). Deferred work orders match neither value. Archived work orders are included either way; add hasSupplierArchived=false to leave them out.

Opciones disponibles:
true,
false
hasSupplierArchived
enum<string>

false leaves out work orders your team has archived; true returns only archived ones. Archiving is separate from status, so open work can be archived too.

Opciones disponibles:
true,
false
locationId
integer

Work at these locations. Get location ids from GET /v1/supplier/location/locations. One value. To match several, use the plural key.

locationIds
string

Work at these locations. Get location ids from GET /v1/supplier/location/locations. Comma-separated list; matches any value listed.

assetId
integer

Work on these assets, whether as the main asset or a sub-asset. Get asset ids from GET /v1/supplier/asset/assets. One value. To match several, use the plural key.

assetIds
string

Work on these assets, whether as the main asset or a sub-asset. Get asset ids from GET /v1/supplier/asset/assets. Comma-separated list; matches any value listed.

problemTypeId
integer

Work of these problem types. Get ids from GET /v1/supplier/work_order/problem_types. One value. To match several, use the plural key.

problemTypeIds
string

Work of these problem types. Get ids from GET /v1/supplier/work_order/problem_types. Comma-separated list; matches any value listed.

woPriorityId
integer

Work at these priorities. Priority ids belong to each client; each work order shows its priority in woPriorityId. One value. To match several, use the plural key.

woPriorityIds
string

Work at these priorities. Priority ids belong to each client; each work order shows its priority in woPriorityId. Comma-separated list; matches any value listed.

labelIds
string

Work carrying at least one of these labels. Get label ids from the label catalog. Comma-separated list; matches any value listed.

isPM
enum<string>

true returns only preventive maintenance work generated from a client's PM schedule; false leaves it out.

Opciones disponibles:
true,
false
fieldTechnicianEmail
string

Work assigned to these technicians as primary technician, or restricted to them, by email address. One value. To match several, use the plural key.

fieldTechnicianEmails
string

Work assigned to these technicians as primary technician, or restricted to them, by email address. Comma-separated list; matches any value listed.

createdAtStartDate
string

Earliest creation time to include. Format MM/dd/yyyy HH:mm:ss, for example 08/01/2026 00:00:00: a local wall-clock time read in timezone, or UTC when timezone is omitted. Don't include an offset in the value: it is ignored. The bound is inclusive. Send either end on its own for an open-ended range. A non-empty value that doesn't parse, such as an ISO 8601 value or a date without a time, is rejected with 400. An empty value is read as 1 January 1970.

createdAtEndDate
string

Latest creation time to include. Format MM/dd/yyyy HH:mm:ss, for example 08/01/2026 00:00:00: a local wall-clock time read in timezone, or UTC when timezone is omitted. Don't include an offset in the value: it is ignored. The bound is inclusive and exact, so send 23:59:59 to include the whole end day. Send either end on its own for an open-ended range. A non-empty value that doesn't parse, such as an ISO 8601 value or a date without a time, is rejected with 400. An empty value is read as 1 January 1970.

completedAtStartDate
string

Earliest completion time to include. Format MM/dd/yyyy HH:mm:ss, for example 08/01/2026 00:00:00: a local wall-clock time read in timezone, or UTC when timezone is omitted. Don't include an offset in the value: it is ignored. The bound is inclusive. Send either end on its own for an open-ended range. A non-empty value that doesn't parse, such as an ISO 8601 value or a date without a time, is rejected with 400. An empty value is read as 1 January 1970.

completedAtEndDate
string

Latest completion time to include. Format MM/dd/yyyy HH:mm:ss, for example 08/01/2026 00:00:00: a local wall-clock time read in timezone, or UTC when timezone is omitted. Don't include an offset in the value: it is ignored. The bound is inclusive and exact, so send 23:59:59 to include the whole end day. Send either end on its own for an open-ended range. A non-empty value that doesn't parse, such as an ISO 8601 value or a date without a time, is rejected with 400. An empty value is read as 1 January 1970.

lastServiceCallServiceScheduledAtStartDate
string

Earliest scheduled time of the most recent visit to include. Format MM/dd/yyyy HH:mm:ss, for example 08/01/2026 00:00:00: a local wall-clock time read in timezone, or UTC when timezone is omitted. Don't include an offset in the value: it is ignored. The bound is inclusive. Send either end on its own for an open-ended range. A non-empty value that doesn't parse, such as an ISO 8601 value or a date without a time, is rejected with 400. An empty value is read as 1 January 1970.

lastServiceCallServiceScheduledAtEndDate
string

Latest scheduled time of the most recent visit to include. Format MM/dd/yyyy HH:mm:ss, for example 08/01/2026 00:00:00: a local wall-clock time read in timezone, or UTC when timezone is omitted. Don't include an offset in the value: it is ignored. The bound is inclusive and exact, so send 23:59:59 to include the whole end day. Send either end on its own for an open-ended range. A non-empty value that doesn't parse, such as an ISO 8601 value or a date without a time, is rejected with 400. An empty value is read as 1 January 1970.

pastDue
enum<string>

true returns open work whose due date has passed; false returns open work that is not yet due. Closed work (Completed or Cancelled) and work with no due date match neither value.

Opciones disponibles:
true,
false
pastSchedule
enum<string>

Like pastDue, on the scheduled visit date: true returns open work whose scheduled date has passed.

Opciones disponibles:
true,
false
pastEstimatedCompletion
enum<string>

Like pastDue, on the estimated completion date you set for the work order. When you haven't set one, the due date is used.

Opciones disponibles:
true,
false
unscheduledOrPastSchedule
enum<string>

true returns work with no scheduled date, or whose scheduled date has passed: work that needs scheduling attention. Closed work is included, so add isActive=true to see only open work.

Opciones disponibles:
true,
false
buyerCompanyId
integer

Work from one client. Get buyer company ids from GET /v1/supplier/buyer_company/buyer_companies. Has no effect for internal service teams, which only ever see their own company's work. One value.

timezone
string

Optional IANA time zone name, such as America/Chicago or UTC, that this route's date filters are read in. Each date filter value is a local wall-clock time in this zone. When omitted, date filters are read in UTC. Names are case-sensitive. Fixed offsets (-05:00, GMT-5, Z, Etc/GMT+5), abbreviations (CST), and unknown names are rejected with 400. On a daylight saving change day, a time in the skipped hour moves forward by the length of the gap, and a time in the repeated hour means the standard-time (second) occurrence.

Ejemplo:

"America/Chicago"

Respuesta

Successful response

type
string
requerido

Entity type label, e.g. "WorkOrder". Endpoints that derive it via Scala reflection (most generic list/get endpoints) may return the fully qualified server class name instead (e.g. "models.workorder.WorkOrder"); treat this field as informational.

data
object[]
requerido
count
integer<int64>
requerido

Total number of matching records (across all pages)

status
enum<string>
requerido

"ok" on success

Opciones disponibles:
ok