Skip to main content
GET
List people

Authorizations

X-API-Key
string
header
required

Owner-typed API key (ORGANIZATION, PERSON, VALUE_UNIT). Manage org-scoped lifecycle with /v1/public-api-keys; cross-org governance is restricted to /v1/sys/public-api-keys.

Query Parameters

_cursor
string
_limit
integer<int32>
Required range: 1 <= x <= 100
externalId
string

Optional external id filter for externally managed identities.

includeDeleted
boolean
default:false

Set to true to include soft-deleted people.

organizationalUnitId
string

Optional organizational unit id filter. Use GET /v1/public/organizational-units and pass a returned data[].id value.

q
string

Optional free-text search across person fields (for example first name, last name, email).

Response

200 - application/json

People listed

id
string
firstName
string
lastName
string
email
string
externalId
string
jobTitle
string
organizationalUnitId
string
organizationalUnitName
string
managerId
string
managerName
string
joined
string<date-time>
basedIn
string
timeZoneName
string
groups
object[]
teams
object[]
workloadScheme
object
holidayScheme
object
deleted
boolean