External DocumentationTo learn more, visit the Sage HR documentation.
Parameters
| Parameter | Description |
|---|---|
| Employment Status History | Specify whether to include employment status history in the retrieved records. |
| Page | The page you want to fetch. |
| Position History | Specify whether to include position status history in the retrieved records. |
| Team History | Specify whether to include team history in the retrieved records. |
Example Output
{
"data": [
{
"city": "London",
"country": "GB",
"date_of_birth": "1991-02-13",
"email": "john@example.com",
"employee_number": "A01",
"employment_start_date": "2014-08-25",
"employment_status": "Full-time",
"employment_status_history": [
{
"employment_statu_name": "Full time",
"employment_status_id": 1,
"end_date": "201-01-01",
"start_date": "2018-01-01"
}
],
"first_name": "John",
"gender": "Male",
"home_phone": "555-0506",
"id": 19,
"last_name": "Doe",
"mobile_phone": "555-0507",
"picture_url": "https://example.com/john.png",
"position": "Api developer",
"position_history": [
{
"end_date": "201-01-01",
"position_code": "1234",
"position_id": 1,
"position_name": "Developer",
"start_date": "2018-01-01"
}
],
"position_id": 123,
"post_code": 99999,
"reports_to_employee_id": 5,
"street_first": "84 Glenwood Street",
"street_second": "Peoria",
"team": "Sage HR",
"team_history": [
{
"end_date": "201-01-01",
"start_date": "2018-01-01",
"team_id": 1,
"team_name": "Some Team"
}
],
"team_id": 1,
"work_phone": "555-0505"
}
],
"meta": {
"current_page": 1,
"next_page": 2,
"per_page": 50,
"previous_page": null,
"total_entries": 75,
"total_pages": 2
}
}