Skip to main content
GET
List organizations

Authorizations

Authorization
string
header
required

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

Query Parameters

include
string

String. Comma-separated list of optional data sections to include in the response. Accepted values: address, invoiceDetails, settings, design, partner, meta.permissions.

Example:

"design,meta.permissions"

linkedOrgs
boolean
default:true

Boolean. When true (default), the list contains organizations administered by any person linked to the authenticated account. When false, only organizations administered by the logged in person are returned. Any value other than false is treated as true.

Example:

false

searchText
string

String. Case-insensitive partial-match filter on organization name. When omitted, all administrable organizations are returned.

Example:

"Acme"

sort
string
default:name:asc

String. Comma-separated list of sorting criteria in property:direction format, where direction is asc or desc. Supported sort properties: name, dateCreated, lastUpdated, status. Example: name:asc,dateCreated:desc. When omitted, results default to name:asc.

Example:

"name:asc"

max
integer<int>
default:10

max records to return

Required range: 1 <= x <= 1000
offset
integer<int>
default:0

the offset to be used in list

Required range: x >= 0

Response

OK

meta
object
required
data
object[]
required
Last modified on August 31, 2026