Returns entitlement table entries for all employees or a specific list of employees. Entitlement is a multi-current history table: an employee may have multiple entitlement types concurrently (for example Lunch vouchers and Company Car), each with its own effective-date timeline. Responses include timeline fields such as effectiveDate, endEffectiveDate, and isCurrent.
There is no per-employee GET for this table — use this bulk endpoint with a single employeeIds value when you need one employee.
You can fetch employee IDs using the People search endpoint.
Required permissions
People's Data > Payroll > View selected employees' Payroll section histories (or View for current-effective rows only), or the equivalent Entitlement table permissions when field-level permissions are enabled.
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
400Bad request.
403Forbidden. The service user does not have permissions to access this table or employees. Check the permissions as explained in the endpoint description.

