List organizations

Returns a paginated list of organizations that the authenticated admin user has permission to administer. Results can be filtered by name, sorted, and paginated. When the account has several persons linked to it, organizations administered by any of those persons are returned by default; set linkedOrgs=false to restrict the list to the logged in person only. The list also holds the template organizations the caller administers through a partner, usable as templateOrganizationId when creating an organization. A template organization carries no employees, partner or design, so design comes back empty and meta is left out for it.

Query Params
string

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

boolean
Defaults to 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.

string

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

string
Defaults to 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.

integer
1 to 1000
Defaults to 10

max records to return

integer
≥ 0
Defaults to 0

the offset to be used in list

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json