---
title: "List right to work entries for a list of employees"
method: GET
path: "/bulk/people/right-to-work"
tags: ["Employee Tables"]
---

# List right to work entries for a list of employees

`GET /bulk/people/right-to-work`

## Request

- Base URL: `https://api.hibob.com/v1`
- URL: `https://api.hibob.com/v1/bulk/people/right-to-work`
- Auth: one of:
  - HTTP basic
  - HTTP bearer

Returns right to work entries for all employees or a specific list of employees.<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 > Right to Work > View (or the equivalent Right to Work table permissions under People's fields).<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>

## Query parameters

- `limit` number
- `cursor` string
- `employeeIds` string
- `includeArchived` boolean

## Response `200`

Right to work table entries.

- BulkRightToWorkTableResponse: Cursor-paginated bulk response for right to work table entries.
  - `results` object[]: Right to work table entries grouped by employee.
    - `employeeId` string: Employee ID these right to work entries belong to.
    - `values` RightToWorkEntry[]: Right to work entries for this employee on the current page.
      - `id` integer: The id of the right to work entry. Assigned by the system on create.
      - `type` string: Right to work document type (list value as stored in Bob).
      - `documentId` number: ID of the document attached to this entry.
      - `expirationDate` string, date: Document expiration date (ISO 8601 date).
      - `number` string: Document or permit number.
      - `issuedBy` string: Issuing authority.
      - `validFrom` string, date: Date from which the document is valid (ISO 8601 date).
      - `applicationDate` string, date: Application date (ISO 8601 date).
      - `customColumns` object: Custom column values for this entry, keyed by column id.
  - `response_metadata` object: Pagination metadata for the bulk response.
    - `next_cursor` string: Contains a string value if there is a 'next' page of data. `null` if there is no more data. Use this value as the `cursor` parameter for pagination to get the next page.
  - `errors` object[]: Permission errors for employees that were requested but could not be read. In the live JSON payload this is an object keyed by employee ID (`{ "<employeeId>": { "error", "message" } }`); documented as an array of entries (same pattern as other bulk employee-table responses) so the schema stays strict without `additionalProperties`.
    - `employeeId` string: Employee ID that could not be accessed.
    - `error` string: Machine-readable error code.
    - `message` string: Human-readable explanation of the permission error.
  - `restricted_columns` RestrictedColumnsMetadata: Indicates which columns were filtered from the response due to field-level permissions. This object is only present when the service user has partial column permissions. To learn more, see <a href="https://apidocs.hibob.com/docs/employee-data-api-field-level-permissions#detecting-restricted-columns-in-api-responses" target="_blank">Field level permissions</a>.
    - `no_view_permission` string[]: Columns filtered because the service user lacks View permission for these fields.
    - `no_view_history_permission` string[]: Columns filtered because the service user lacks View History permission. Only present for historical tables (work, employment, salaries, lifecycle).

## Other responses

- `400`: Bad request.
- `403`: Forbidden. The service user does not have permissions to access this table or employees. Check the permissions as explained in the endpoint description.

## Changes

- **2026-11-03** `9ac25373a355`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/hibob/apis/employee-data-api/changes/bulk/people/right-to-work/get.md)

---

[API](https://skmtc.dev/hibob/apis/employee-data-api.md) - [All operations](https://skmtc.dev/hibob/apis/employee-data-api/llms.txt) - [OpenAPI document](https://skmtc.dev/hibob/apis/employee-data-api/revisions/9ac25373a355?raw)