List custom table entries for a list of employees

Returns the entries of one custom table for all employees or a specific list of employees, in a single paginated call. The rows have the same shape as the response of Read all entries of the given custom table. Use Read metadata of custom tables defined to get the custom table ID and its columns.

Only custom tables created in Bob are supported. Out-of-the-box employee tables are read with their own /bulk/people/{table} endpoints.

You can fetch employee IDs using the People search endpoint.

Required permissions
People's Data > People's fields > the custom table's category > View (or Edit), or the equivalent permissions on the custom table under People's fields.
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. The limit counts table entries (rows), not employees, so the entries of one employee can span two pages. To learn more, see Pagination in Bob's API

Path Params
string
required

The ID of the custom table. You can get it from the Read metadata of custom tables defined endpoint.

Query Params
integer
1 to 200
Defaults to 50

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

string

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 Pagination in Bob's API.

string

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 People search endpoint.

boolean
Defaults to false

By default (false), archived columns are excluded from the response. When set to true, archived columns are included. This parameter has no effect when field-level permissions are enabled for the company: archived columns are not returned in that case.

boolean
Defaults to false

Whether to include the additional "humanReadable" JSON node in each entry of the response.

Responses

400

Bad request. For example: limit is above 200, more than 200 employeeIds were passed, or the cursor is not valid.

403

Forbidden. The service user does not have permissions to access this table. Check the permissions as explained in the endpoint description.

404

Not found. The custom table does not exist, or the ID belongs to an out-of-the-box employee table, which is read with its own /bulk/people/{table} endpoint.

Language
Credentials
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json