Skip to main content
GET
Count the organisation's employees: total, active, leavers and future leavers

Authorizations

X-Auth-Token
string
header
required

Access token obtained from OAuth2 client credentials flow

X-Org-Id
string
header
required

Organisation to scope the request to. Required when the principal can access more than one organisation; optional for single-organisation principals (the authorizer resolves it automatically).

Headers

Request-Id
string

Optional. Your id for this request: it is carried into every log line about it, so quote it when you contact support.

Query Parameters

asAt
string<date>

The date to count for, yyyy-MM-dd; today when omitted.

Response

Employees counted

message
object
required

A readable message about the outcome and a stable token a client can branch on.

content
object

The data the request returns with its metadata; left out on a response that carries no data, such as most errors.

validationIssues
object[] | null

Each field the request was refused for and why; left out when the request was not refused for its fields.