List employment history for a list of employees.
Returns a list of historical employment entries from the employment table for all employees or a specific list of employees.
Each employment entry includes the working pattern assigned to this employee. To learn more about working patterns, see How to work with Working patterns.
Required permissions
In order to access the employment history of each requested employee, the service user making the call must have the following permissions:
-
For all the employment table entries: People's Data > Employment > View selected employees' Employment section histories.
-
For the current effective employment entry only: People's Data > Employment > View selected employees' Employment sections.
-
For the employees: People's Data > Access data for: Make sure the employees are in the list. Employees that are not listed and were specifically requested will be listed under `errors` in the response.
Pagination
This endpoint uses cursor-based pagination to handle large number of table entries. To learn more, see Pagination in Bob's API.
Query parameters
Specifies the number of table entries to include on each page of the results.
A marker representing the first item on the next page to read. Make sure to URL encode this value before you send it as a query parameter. To learn more, see <a href="https://apidocs.hibob.com/docs/pagination" target=”_blank”>Pagination in Bob's API</a>.
Comma separated list of employee ids. Maximum employees per request: 200. If this parameter is not passed, the API will return history records for all the employees for which the service user has the permission for.
By default (false), archived columns are excluded from the response. When set to true, archived columns are included.
Response
Employment table entries.
Example response
{
"results": [
{
"values": [
{
"values": [
{
"actualWorkingPattern": {
"workingPatternType": "hourly",
"days": {
"monday": 9,
"tuesday": 9,
"wednesday": 9,
"thursday": 9,
"friday": 9
},
"hoursPerDay": 9
},
"siteWorkingPattern": {
"workingPatternType": "hourly",
"days": {
"monday": 9,
"tuesday": 9,
"wednesday": 9,
"thursday": 9,
"friday": 9
},
"hoursPerDay": 9
}
}
]
}
]
}
],
"errors": [
{
"employeeId": {
"error": "MISSING_PERMISSION",
"message": "You don't have permission to access data for employees with ids: 2578509511618723822"
}
}
]
}