List people

Operation ID: people

Group: People Management › People

Open in the interactive reference

GET /people/person

Read-only: Reads and returns; changes nothing.

Lists people. GET people/person/:id returns a richer record, including compensation and external identifiers.

To filter by name, email, employeeNumber, or external identifier, use POST people/person/search.

Parameters

Name In Type Required Description
Api-Version header string · v1 yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.

Query surface

Response

200 Success

Under data, an array of peopleRow:

Field Type Required Filter Sort Description
id string no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The unique identifier for the person.
employeeNumber string | null no no yes The person's business number.
firstName string | null no no no The person's first name.
lastName string | null no no no The person's last name.
name string | null no no no The person's full name, in first-name-last-name order.
displayName string | null no no no The name the person goes by: their preferred first and last name where set, otherwise their legal name. Returned only — it can be neither filtered nor sorted on.
email string | null no no no The person's work email address.
status string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The current employment status of the person. Possible values: 'Active', 'Inactive', 'Planned', 'Cancelled'.
employmentCategory string | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) yes The employment category assigned to this person.
weeklyWorkingHours decimal | null no no no The person's standard working hours per week, for example 40 for full time. A number of hours, not an amount.
entityId string | null no no no The legal entity the person is employed by.
entityName string | null no no no The name of the legal entity this person belongs to.
locationName string | null no no no The name of this person's work location.
lastModifiedDate date-time | null no Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) yes The date and time the person record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. 
{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "employeeNumber": "<employeeNumber>",
      "firstName": "<firstName>",
      "lastName": "<lastName>",
      "name": "<name>",
      "displayName": "<displayName>",
      "email": "<email>",
      "status": "<status>",
      "employmentCategory": "<employmentCategory>",
      "weeklyWorkingHours": "19.99",
      "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "entityName": "<entityName>",
      "locationName": "<locationName>",
      "lastModifiedDate": "2026-01-15T09:30:00.000Z"
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "<nextCursor>"
  }
}

Statuses