Skip to main content
GET
List work orders

Autorisations

X-API-KEY
string
header
requis
OW-KEY
string
header
requis

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

Paramètres de requête

offset
integer

Number of records to skip.

Plage requise: 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.

Options 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.

Réponse

Successful response

type
string
requis

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[]
requis
count
integer<int64>
requis

Total number of matching records (across all pages)

status
enum<string>
requis

"ok" on success

Options disponibles:
ok