Skip to main content
GET
List org units
Lists org units inside the current workforce scope closure. Optional filters are status (ACTIVE or INACTIVE) and parentUnitId. Customer organizations and the org units under them are excluded. A page holds up to limit visible org units and is short or empty only when it is the last page; follow meta.nextCursor while meta.hasMore is true.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Query Parameters

limit
integer
default:50
Required range: 1 <= x <= 100
cursor
string
Minimum string length: 1
status
enum<string>
Available options:
ACTIVE,
INACTIVE
parentUnitId
string
Minimum string length: 1

Response

Success

data
object[]
required
meta
object
required

A list page's continuation. While hasMore is true, nextCursor is a string: pass it as cursor for the next page. hasMore: false ends the list; with truncated: true, more exist past what this list reads, and no cursor reaches them.