Skip to main content
GET
List workers
Lists worker seats in worker-ID order, optionally only one workerType or status: name, type, status, person ID, current position and its team and department. It never returns the owner’s email, metadata, agent configuration, budget or spend; read a person’s budget with Get person. A worker with any current or upcoming assignment in a customer organization or an org unit under one is left out, and so is every seat of a person with any such seat (the person Get person does not find). limit is 1–100 (default 50; a larger value is 400 too_big). Continue while meta.hasMore is true with meta.nextCursor. A page may stop short of limit when the scan reaches its budget; then meta.partial is true and the cursor continues after the last worker scanned. An unknown query parameter returns 400. Requires workforce:read at the platform scope; a key or app whose grant covers only some org units receives 403.

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

workerType
enum<string>
Available options:
EMPLOYEE,
CONTRACTOR,
AGENT
status
enum<string>
Available options:
ACTIVE,
INACTIVE,
SUSPENDED
limit
integer
default:50
Required range: 1 <= x <= 100
cursor
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.