Skip to main content
GET
List regions

Auktoriseringar

X-API-KEY
string
header
obligatorisk
OW-KEY
string
header
obligatorisk

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

Frågeparametrar

offset
integer

Number of records to skip.

Obligatoriskt intervall: x >= 0
limit
integer

Page size. Default 10, maximum 25.

sort_by
string

Column name to sort by.

order
enum<string>

Sort direction.

Tillgängliga alternativ:
asc,
desc

Svar

Successful response

type
string
obligatorisk

Entity type label, e.g. "Region". 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[]
obligatorisk
count
integer<int64>
obligatorisk

Total number of matching records (across all pages)

status
enum<string>
obligatorisk

"ok" on success

Tillgängliga alternativ:
ok