Skip to main content
GET
Get Organizational Units

Authorizations

Authorization
string
header
required

Bearer token for authentication

Query Parameters

pagination
CursorPagination · object

Bracket syntax, one key per field: pagination[first]=50, then pagination[first]=50&pagination[after]=<end_cursor> for the next page.

Cursor pagination

filters
OrganizationalUnitFilter · object

Filter parameters for OrganizationalUnit

Bracket syntax, two keys per filtered field: filters[<field>][op]=<op>&filters[<field>][value]=<value>, e.g. filters[updated_at][op]=gt&filters[updated_at][value]=2026-01-01T00:00:00Z. Combine fields by adding more keys; every filter must match.

With op=in, separate the values with commas: filters[id][op]=in&filters[id][value]=<uuid>,<uuid>. filters[id][value][]=<uuid>&filters[id][value][]=<uuid> is accepted too.

Parameters for OrganizationalUnit filtering

select
enum<string>[]

Select fields for OrganizationalUnit

Separate values with commas: select=name,description. These are accepted too:

  • select[]=name&select[]=description
  • select=name&select=description
  • select[0]=name&select[1]=description

Spaces around the commas are ignored. Values are case-sensitive, and an unknown value returns 400. Parameters for OrganizationalUnit field selection. Note: id is always returned.

Available options:
id,
org_id,
parent_id,
updated_at,
inserted_at,
tier,
name,
description,
properties
relations
enum<string>[]

Relations to include for each OrganizationalUnit. organizational_unit_mappings adds the unit's id in every integration that knows it.

Example: relations=organizational_unit_mappings. Values are case-sensitive, and an unknown value returns 400. Parameters for OrganizationalUnit relations selection.

Available options:
organizational_unit_mappings
order
OrganizationalUnitOrder · object

Bracket syntax: order[field]=<field>&order[direction]=desc. Parameters for OrganizationalUnit ordering

condition_id
string<uuid>

Id of an organization-wide condition (see GET /v1/org/conditions) whose domain is org_unit. Only records the condition passes are returned; filters still apply first. Record properties are encrypted at rest, so the condition runs in the application after the page is read and decrypted: a page may be shorter than first, even empty, while has_next_page is still true. Keep paging until has_next_page is false. pagination[last] / pagination[before] are not supported together with a condition. An unknown id or a condition of another domain is a 400. No permission on conditions is needed to filter by one; list on this resource is enough.

Response

Response

A paginated list of OrganizationalUnits

data
OrganizationalUnit · object[]
required
pagination
CursorPaginationResult · object
required

Cursor pagination result