The Bob API Reference lists the available endpoints and allows you to test endpoints and develop your app efficiently.

Connect to Bob API

Define API Service Users: Learn how to connect to your Bob workspace via the API using service users.

Explore Bob API endpoints

Click on Bob API's modules below to access detailed information on all available endpoints.

Here's a highlight on a few endpoints that may be useful:

Metadata Endpoints: Pull all the details about how Bob keeps the data. Use the 'Get Company Lists' to review all the lists in Bob, or the 'Get All Company Fields' to find out the properties and backend IDs of all the fields, tables, and custom fields in Bob. To learn more, see Fields and lists metadata.
People, Employee Tables and Custom Tables endpoints: Access fields, custom fields and history data of employees. To learn more, explore How to read employee data.
Time off endpoints: Access and add time off requests and policies.
Reports endpoints: Download reports from Bob.
Hiring endpoints: Fetch job ads from Bob's careers page and post them to your custom careers page.
Workforce Planning endpoint: Access data about positions in your company

And there are many more, click the topic that you want to learn about under BOB API ENDPOINTS.

Explore Webhooks

If you plan to connect to Bob via webhooks, explore Getting Started with Webhooks to learn how to subscribe to events in Bob and build your own event listener.

Test endpoints

You can test the API directly from the "Try It!" option in the interactive API reference guide. This feature helps you understand how the API works and verifies that your parameters and permissions are set correctly.

To learn more, see Testing.