Bob's People API provide powerful tools for accessing and managing employee data within your organization. These endpoints enable searching, creating, updating, and retrieving employee data.

Getting Started with People API

• Explore People endpoints: Click on the endpoints below to access detailed information on each endpoint, and try the API via the interactive Try It! option.
• Explore How to read employee data: Learn how to map the fields and their properties and how to process the response payload.
• Explore the Employee Tables endpoints: Employee fields consist of data fields and tables that store several entries of data per employee. To access data stored in the employee table entries, use the employee tables endpoints.

Required Permissions

In Bob API the permissions are granted to the service user that is used to access the API. The fields are organized within categories and the permission are granted to the category and as a result, to all the fields that reside in that category.

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

For example, if you need the service user to pull employee 'Personal contact' category, you would set permissions to:

• People’s data permissions:
  • People > Personal contact details > View selected employees' Personal contact details sections
• Access rights permissions:
  • 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 .

📘

Accessing historical data

When setting access to categories with historical information, setting 'view' access to the category will give you access only to the current entry, for example, the employee's effective work entry. To read the whole work history, you would need to use the tables endpoints, and set access also to the 'histories' data. To learn more, see Employee Tables.

Rate limiting

Below is a table detailing the rate limits for each endpoint in the People's endpoints.