Skip to main content
GET
List resources

Authorizations

Authorization
string
header
required

API key from Developers → API Keys, sent as Authorization: Bearer .

Query Parameters

page
integer

Offset pagination is bounded at page 10000 (higher values are clamped — meta.current_page reports the page served); use cursor pagination for deeper walks.

Required range: 1 <= x <= 10000
page_size
integer
Required range: 1 <= x <= 100
cursor
string

Cursor pagination: send empty to start, then the token from links.next. Constant cost per page and stable under concurrent writes; response meta is {per_page, has_more} and links.first/prev are null. Bound to the filters, sort and page_size it was issued for (422 otherwise). Omit to use page/page_size.

sort
string

attr[,attr]:asc|desc — sortable: id, name, display_order, updated, created

id
string

Filter: operator:value

location_id
string

Filter: operator:value

name
string

Filter: operator:value

public_name
string

Filter: operator:value

description
string

Filter: operator:value

color
string

Filter: operator:value

display_order
string

Filter: operator:value

status
string

Filter: operator:value

locked
string

Filter: operator:value

updated
string

Filter: operator:value

created
string

Filter: operator:value

metadata
object

Filter by integrator metadata: metadata[key]=operator:value

Response

Page of resources

data
object[]
meta
object