Employee Tables

The Employee Tables API provides access to the details of your company employees's data tables.

Employee tables endpoints provide access to table entries of employees' historical data and other types of information stored in tables holding multiple rows.

Reading employee tables

Employee data includes tables that store several entries of data per employee. To access data stored in the employee table entries, use the employee tables endpoints below.

Before you start, explore How to read employee data to learn how to map the fields and their properties and how to process the response payload.

Required Permissions

Employee tables are organized within categories. Grant access under People’s data > People’s fields at the category level or on individual columns/fields.

Before accessing a table, ensure the service user has permissions to the relevant category or fields, just like you would do with a user within Bob.

For example, if you need the service user to pull employee work history, set permissions under People’s data > People’s fields:

  • Work category / historical table row:
    • View history — access to all rows in the table (category/table-level only; not available per field)
    • View — required for column access on historical rows as well as the current effective row (category/table or specific fields). Without View, columns can still appear under restricted_columns.no_view_permission even when View history is granted.
  • In the Bob UI, historical tables are labeled with a (Table) suffix (for example Salary (Table), Variable Pay (Table), Lifecycle (Table), Deduction (Table), Entitlement (Table), Actual Payments (Table)).
  • Access rights:
    • Select “Everyone” (if you need to access all employees).
    • Or include the employee in the list of selected users.

To learn more, see Categories and Permissions.

To learn more about permissions, see Setting permissions to Service Users .

📘

Note: When the service user has partial column access, the response includes a
restricted_columns object indicating which columns were filtered. See
Field level permissions
for details.

Pagination

Some of the endpoints use cursor-based pagination to go through the results. It's the fastest and most reliable way to handle a large number of items.

To learn more, see Pagination in Bob's API.

Rate limiting

Rate limits are restrictions that our API imposes on the number of times a user can access our endpoints within a specified period of time. To learn more about rate limiting best practices, see Rate limiting.

Below is a table detailing the rate limits for each endpoint in the Employee tables endpoints.

MethodEndpointLimit per minute
GETList work history for a list of employees100
GETList the lifecycle history for a list of employees100
GETList employment history for a list of employees.100
GETList payroll history (salaries) for a list of employees.100
GETList dependents for a list of employees100
GETList right to work entries for a list of employees100
GETList variable pay entries for a list of employees100
GETList entitlement entries for a list of employees100
GETList deduction entries for a list of employees100
GETList employee's employment history50
POSTCreates a new employment entry for a given employee10
PUTUpdate an employment entry from a given employee's employment history10
GETList employee's work history50
POSTCreate a new work entry for a given employee10
PUTUpdate a work entry in the employee's work history table10
DELETEDeletes a work entry from a given employee's work history10
GETList employee's life-cycle status history50
GETList employee's salary history10
POSTCreates a new salary entry for a given employee10
DELETEDeletes a salary entry from the employee's list10
GETList the employee's training records50
POSTCreates a new training records for a given employee10
DELETEDeletes any training records for an employee10
POSTCreate a dependent entry for an employee10
PUTUpdate a dependent entry for an employee10
DELETEDelete a dependent entry for an employee10
POSTCreate a right to work entry for an employee10
PUTUpdate a right to work entry for an employee10
DELETEDelete a right to work entry for an employee10
GETRead payroll history20
GETList the employee's equity grants50
POSTCreates a new equity grant for a given employee10
PUTUpdates an equity grant for an employee10
DELETEDeletes an equity grant for an employee10
GETList employee's variable payments50
POSTCreates a new variable payment for a given employee10
PUTUpdate a variable payment for an employee10
DELETEDeletes a variable payment record for an employee10
POSTCreate an entitlement entry for an employee10
PUTUpdate an entitlement entry for an employee10
DELETEDelete an entitlement entry for an employee10
POSTCreate a deduction entry for an employee10
PUTUpdate a deduction entry for an employee10
DELETEDelete a deduction entry for an employee10
GETRead all open tasks50
GETRead tasks of a specific employee50
POSTSearch for actual payments100
GETList equity grants for a list of employees100
GETList employee's bank accounts50
POSTCreate a new bank account entry for a given employee.10
PUTUpdate a bank account entry in the employee's bank accounts table.10
DELETEDeletes a bank account entry from a given employee's bank accounts table.10