Skip to main content
GET
List organisations

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
number
default:50

Maximum number of items to return (1-100).

Required range: x <= 100
Example:

50

cursor
string

Opaque cursor returned in the previous response's next_cursor. Omit to fetch the first page.

include_total
default:false

Set to true to include total in the response.

Example:

false

order
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc
Example:

"desc"

sort
enum<string>

Field used to sort the results.

Available options:
created_at,
updated_at
created_at
string<date-time>
created_at__not
string<date-time>
created_at__isNull
string<date-time>
created_at__isNotNull
string<date-time>
created_at__equals
string<date-time>
created_at__lt
string<date-time>
created_at__lte
string<date-time>
created_at__gt
string<date-time>
created_at__gte
string<date-time>
updated_at
string<date-time>
updated_at__not
string<date-time>
updated_at__isNull
string<date-time>
updated_at__isNotNull
string<date-time>
updated_at__equals
string<date-time>
updated_at__lt
string<date-time>
updated_at__lte
string<date-time>
updated_at__gt
string<date-time>
updated_at__gte
string<date-time>

Response

data
object[]
required

List of Organisation.

next_cursor
string | null
required

Cursor to fetch the next page. null when there are no more items.

Example:

null

has_more
boolean
required

Whether more items are available after this page.

Example:

false

total
number

Total number of items matching the filters. Only present when include_total=true was passed.

Example:

1