Skip to main content
GET
List work order labels

Authorizations

X-API-KEY
string
header
required
OW-KEY
string
header
required

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

Query Parameters

offset
integer

Number of records to skip.

Required range: x >= 0
limit
integer

Page size. Default 10, maximum 25.

sort_by
string

Column name to sort by.

order
enum<string>

Sort direction.

Available options:
asc,
desc

Search filter matched against the label text.

label
string

Filter by label text.

no_pagination
boolean

Set to true to return the whole catalog in one page (offset and limit are ignored; sorting still applies). A non-boolean value is treated as unset.

Response

Success.

type
string
required

Entity type marker, "WorkOrderLabel".

data
object[]
required
count
integer
required

Total labels matching the filters, across all pages.

status
enum<string>
required
Available options:
ok