People
GET /people
Group: People Management › People · Operation ID: people
Returns a list of people. To filter by name, email or business number, use POST people/search. GET people/:id returns a richer record, including compensation and external identifiers.
Open in the interactive reference
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
Api-Version |
header | "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
id— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likestatus— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likeemploymentCategory— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likelastModifiedDate— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like- Orderable: id, employeeNumber, status, employmentCategory, lastModifiedDate
- Selectable: id, employeeNumber, firstName, lastName, name, email, status, employmentCategory, entityName, locationName, lastModifiedDate
Response
200 Success
Under data, an array of peopleRow:
| Field | Type | Required | Description |
|---|---|---|---|
id |
string | no | The unique identifier for the person. |
employeeNumber |
string or null | no | The person's business number. |
firstName |
string or null | no | The person's first name. |
lastName |
string or null | no | The person's last name. |
name |
string or null | no | The person's full name, in first-name-last-name order. |
email |
string or null | no | The person's work email address. |
status |
string or null | no | The current employment status of the person. Possible values: 'Active', 'Inactive', 'Planned', 'Cancelled'. |
employmentCategory |
string or null | no | The employment category assigned to this person. |
entityName |
string or null | no | The name of the legal entity this person belongs to. |
locationName |
string or null | no | The name of this person's work location. |
lastModifiedDate |
string (date-time) or null | no | The date and time the person record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. |
Statuses
400— Invalid request or business failure401— Missing or invalid access token403— Not authorized404— Not found429— Too many requests500— Internal server error