HIhibob
Employee Tables

List entitlement entries for a list of employees

Changed on

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.<br /> <br /> There is no per-employee GET for this table — use this bulk endpoint with a single employeeIds value when you need one employee.<br /> <br /> You can fetch employee IDs using the <a href="https://apidocs.hibob.com/reference/post_people-search" target="_blank">People search</a> endpoint.<br /> <br /> <b>Required permissions</b> <br /> People's Data > People's fields > Entitlement (Table) > View history (and View on the table or required columns), or View for current-effective rows only.<br /> 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. <br /> <br /> <b>Pagination</b> <br /> This endpoint uses cursor-based pagination to handle large number of table entries. To learn more, see <a href="https://apidocs.hibob.com/docs/pagination" target="_blank">Pagination in Bob's API</a>

get/bulk/people/entitlement

Request

  • Base URL
    https://api.hibob.com/v1
  • URL
    https://api.hibob.com/v1/bulk/people/entitlement
  • Auth
    • HTTP basic
    • or HTTP bearer

Query parameters

limitnumber

Specifies the number of table entries to include on each page of the results.

cursorstring

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>.

employeeIdsstring

Comma separated list of employee ids. Maximum employees per request: 200. If this parameter is not passed, the API will return table entries for all the employees for which the service user has the permission for. You can fetch employee IDs using the <a href="https://apidocs.hibob.com/reference/post_people-search" target="_blank">People search</a> endpoint.

includeArchivedboolean

By default (false), archived columns are excluded from the response. When set to true, archived columns are included.

Response

Entitlement table entries.

Example response

{
  "errors": [
    {
      "error": "MISSING_PERMISSION",
      "message": "You don't have permission to access data for employee with id other-employee"
    }
  ]
}

Changes