Skip to main content
GET
List locations

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; values above 10 are reduced to 10 on this endpoint.

sort_by
string

Column name to sort by.

order
enum<string>

Sort direction.

Options disponibles:
asc,
desc

Réponse

Successful response

type
string
requis

Entity type label, e.g. "Location". 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