Get started with Bob's API reference guide
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:
| Endpoints | Description |
|---|---|
| Metadata | Pull all the details about how Bob keeps the data. Fetch the properties of fields, lists, tables, and custom fields in Bob. To learn more, see Fields and lists metadata. |
| Employee data, Tables, Custom Tables | Access fields, custom fields, and employee history data. Explore Explore employee data API. |
| Time off | Access and add time off requests and policies. |
| Reports | Download reports from Bob. |
| Workforce Planning | Fetch job ads from Bob's careers page and post them to your custom careers page. |
| Hiring | Access data about positions in your company |
And there are many more, click the topic that you want to learn about under BOB API.
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.