Early access
List all people
Returns a list of people
Returns a list of people
Query Parameters
Page offset to fetch.
int321Number of results to return per page.
int3250Pad a number of results.
int320Filter by person IDs. e.g., ids[]=1&ids[]=2
Filter by person numbers. e.g., person_numbers[]=P001&person_numbers[]=P002
Filter by manager ID
int32Filter by legal entity ID
int32Filter by status. Allowed values: active, employed, terminated, hired, probation, all. Default: all
"all"Value in
- "active"
- "employed"
- "terminated"
- "hired"
- "probation"
- "all"
hired_on after a date (YYYY-MM-DD)
datehired_on on or after a date (YYYY-MM-DD)
datehired_on before a date (YYYY-MM-DD)
datehired_on on or before a date (YYYY-MM-DD)
datecreated_at after an ISO 8601 date or timestamp
date-timecreated_at on or after an ISO 8601 date or timestamp
date-timecreated_at before an ISO 8601 date or timestamp
date-timecreated_at on or before an ISO 8601 date or timestamp
date-timeResponse Body
application/json
curl -X GET "https://example.com/api/v4/people"{ "data": [ { "id": 0, "status": "string", "access": "string", "employee_number": "string", "full_name": "string", "first_name": "string", "middle_name": "string", "last_name": "string", "avatar_url": "string", "email": "string", "personal_email": "string", "work_phone_number": "string", "mobile_number": "string", "date_of_birth": "2019-08-24", "probation_ends_on": "2019-08-24", "hired_on": "2019-08-24", "gender": { "id": 0, "name": "string" }, "position": { "id": 0, "name": "string" }, "job_level": { "id": 0, "name": "string" }, "location": { "id": 0, "name": "string" }, "employment_type": { "id": 0, "name": "string" }, "division": { "id": 0, "name": "string" }, "department": { "id": 0, "name": "string" }, "reporting_to": { "id": 0, "first_name": "string", "last_name": "string", "email": "string", "type": "string" }, "job_profile": { "id": 0, "name": "string" }, "legal_entity": { "id": 0, "name": "string" }, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "termination_effective_on": "string", "termination_comment": "string", "termination_eligible_for_rehire": "string", "termination_type": { "id": 0, "name": "string" }, "termination_reason": { "id": 0, "name": "string" } } ], "metadata": { "page": 0, "per_page": 0, "total_pages": 0, "total_count": 0 }}