The Bob API Reference lists the available endpoints and allows you to test endpoints and develop your app efficiently.
Learn how to use this website
To access the documentation from non-browser tooling during development, see Accessing the documentation programatically.
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.
Use the table below to jump to each module’s main subsection pages. Each link opens that subsection’s overview in the API reference; use the sidebar on those pages for every endpoint and operation.
| Module | Section | Description |
|---|---|---|
| Employee data API | People | Read and update employee profiles and person-level fields. |
| Onboarding | Work with onboarding wizards and related configuration. | |
| Metadata | Discover field IDs, lists, tables, and how data is modeled in Bob. | |
| Employee tables | Access multi-row tables such as work, employment, lifecycle, and compensation history. | |
| Custom tables | Read and write company-defined custom tables per employee. | |
| Employee data webhooks | Subscribe to employee lifecycle, field update, and table entry events. | |
| Time off API | Time off | Create, update, and query time off requests and related data. |
| Time off balance | Retrieve balances and balance-related information for employees. | |
| Time off policies | Work with policies and policy configuration behind time off. | |
| Calendar events | Manage calendar-linked events in the time off domain. | |
| Time off webhooks | Subscribe to time off request lifecycle and related events. | |
| Attendance API | Attendance | Record and search attendance entries, clock in/out, and daily breakdowns. |
| Projects | Manage attendance projects, clients, and tasks used with time tracking. | |
| Tasks API | Tasks | Create and manage tasks and task lists for employees. |
| Tasks webhooks | Subscribe to task assignment and status events. | |
| Reports API | Reports | Run and download reports defined in Bob. |
| Docs API | Documents | List, upload, and manage employee documents and folders. |
| Docs webhooks | Subscribe to document and e-sign workflow events. | |
| Goals API | Goals | Access goals and key results for employees and teams. |
| Job Catalog API | Job catalog | Manage job profiles and catalog structure used across Bob. |
| Workforce Planning API | Workforce planning | Plan and query positions, openings, budgets, and related workforce data. |
| Workforce planning webhooks | Subscribe to position and opening change events. | |
| Bob Hiring API | Job openings | Search and manage hiring job openings. |
| Candidates | Work with candidates in the hiring pipeline. | |
| Applications | Search and track applications against openings. | |
| Job ads | Fetch job ads shown on Bob's careers page for external career sites. | |
| Bob Learning API | Provider integrations | Register LMS providers, push training content, and report learner progress. |
And there are many more, explore the reference guide menu for all available APIs.
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.
Explore webhooks events for modules that support webhooks:
Accessing documentation programmatically
The developer documentation at this website is published as an interactive site. If you need to access the documentation programmatically, via HTTP clients, curl, or any non-browser tooling during development, some pages may return empty HTML with no readable content.
To reference documentation during the implementation phase, you can use these options instead:
- Markdown exports: The articles are also available as Markdown by using the same path with a .md suffix (for example, the webhooks guide:
https://apidocs.hibob.com/reference/getting-started-webhooks.md. A GET request for these URLs returns Markdown suitable for version control, search, and offline use. - Documentation index: Use the https://apidocs.hibob.com/llms.txt which lists curated links to Markdown versions of guides and reference pages, including webhooks and API definitions. Use it as a stable entry point when you need to discover or bulk-fetch machine-friendly documentation.
- OpenAPI definitions: Endpoint and webhook reference pages include the relevant OpenAPI definition in the Markdown version. Use the .md suffix to daccess the authoritative contract (schemas, parameters, and examples).
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.