# Developer Docs Documentation > The Developer Docs is where you'll find comprehensive guides and documentation to help you start working with Bob as quickly as possible. This file lists one part of the documentation. The full index is at https://apidocs.hibob.com/llms.txt. ## API Reference: Start developing - [Start developing with the API](https://apidocs.hibob.com/reference/getting-started-with-bob-api.md): Get started with Bob's API reference guide ## API Reference: Core Concepts - [Authorization](https://apidocs.hibob.com/reference/authorization.md): How to build the authorization header when sending HTTP calls to Bob. - [Permissions](https://apidocs.hibob.com/reference/permissions.md): Learn about setting service user permissions to access the data in Bob - [Testing](https://apidocs.hibob.com/reference/testing.md): Learn how to test endpoints using your own data - [Rate limiting](https://apidocs.hibob.com/reference/rate-limiting.md): Learn how we limit access to endpoints and to our server - [Pagination](https://apidocs.hibob.com/reference/pagination-1.md): Bob offers cursor-based pagination for some of our API’s collection endpoints. - [Object-based endpoints](https://apidocs.hibob.com/reference/object-based-endpoints.md): Learn about the new object-based endpoints in our public API - [Error handling](https://apidocs.hibob.com/reference/error-handling.md): Learn how Bob's public APIs handle errors ## API Reference: Core concepts for partners - [OAuth 2.0](https://apidocs.hibob.com/reference/oauth-20.md): Learn how partners can use HiBob's OAuth Integration - [Scopes mapping to endpoints](https://apidocs.hibob.com/reference/scopes-mapping-to-endpoints.md): Learn how to work with scopes when integrating with ob ## API Reference: Webhooks - [Getting started with Webhooks](https://apidocs.hibob.com/reference/getting-started-webhooks.md): Learn how to subscribe to events in Bob and be notified whenever a change occurs. - [Sample API calls from webhook](https://apidocs.hibob.com/reference/api-calls-for-webhook-events.md): API calls examples to retrieve the data relevant to webhook events - [[ Legacy] Webhooks v1](https://apidocs.hibob.com/reference/webhook-events-v1.md) - [Employee events (v1 Legacy)](https://apidocs.hibob.com/reference/employee-changes-events.md): The following events can be used to create Employee data updates Webhooks. - [Time off events (v1 Legacy)](https://apidocs.hibob.com/reference/time-off-webhook-events.md): The following events can be used to create Time off request Webhooks. - [Task events (v1 Legacy)](https://apidocs.hibob.com/reference/employee-task-events.md): Receive notifications about triggered task lists and tasks status updates. - [eSign events (v1 Legacy)](https://apidocs.hibob.com/reference/esign-document-signing-event.md) ## API Reference: Employee data API - [People](https://apidocs.hibob.com/reference/people.md): The People API provides access to the details of your company employees. - [Search for employees](https://apidocs.hibob.com/reference/post_people-search.md): Search employee fields for many employees in one call.

See Critical behaviors below on this page for field IDs, filters, showInactive, permissions, no pagination, large-company… - [Read company employee fields by employee ID.](https://apidocs.hibob.com/reference/post_people-identifier.md): Single-employee read endpoint (not bulk search): returns field data for one employee identified by backend ID or email in the path in a single response. No pagination. For many… - [Update company employee.](https://apidocs.hibob.com/reference/put_people-identifier.md): This endpoint allows you to update specific fields in an employee's record in Bob.

**Important**: Although this is a PUT method, it behaves like a PATCH request—you only need to send the… - [Read the public profile section of all active employees.](https://apidocs.hibob.com/reference/get_profiles.md):

Returns a predefined list of fields for all active employees the service user can access. Refer to the '200' response for the response schema.

Ensure the service user has the… - [Create company employee.](https://apidocs.hibob.com/reference/post_people.md):
This endpoint allows you to create a new employee in the system.
The request body must include the minimum required fields: `email`, `firstName`, `surname`, and the `work` object with `site`… - [Revoke access to Bob for an employee.](https://apidocs.hibob.com/reference/post_employees-identifier-uninvite.md):

Explore the People API main reference page for information about rate limits, permissions, troubleshooting and more.

- [Terminate company employee.](https://apidocs.hibob.com/reference/post_employees-identifier-terminate.md): This changes the employee’s status to Terminated according to specified termination date.

Explore the People API main reference page… - [Invite an employee with a welcome wizard ID.](https://apidocs.hibob.com/reference/post_employees-employeeid-invitations.md):

Explore the People API main reference page for information about rate limits, permissions, troubleshooting and more.

- [Set or update an employee's start date.](https://apidocs.hibob.com/reference/post_employees-employeeid-start-date.md):

Explore the People API main reference page for information about rate limits, permissions, troubleshooting and more.

- [Read avatar for an employee email](https://apidocs.hibob.com/reference/get_avatars.md): Returns the avatar image URL of the employee. - [Read avatar for an employee ID.](https://apidocs.hibob.com/reference/get_avatars-employeeid.md): Returns the avatar image URL of the employee. - [Upload employee's avatar by image url](https://apidocs.hibob.com/reference/put_avatars-employeeid.md): Upload an employee's Avatar by providing a URL to the image to upload.
- [Update an employee's email address.](https://apidocs.hibob.com/reference/put_people-id-email.md): Change an employee's email address. If you cannot change the self email an invitation will be sent to the new address to verify the email if the employee is invited/active.
- [Onboarding](https://apidocs.hibob.com/reference/onboarding.md): The Onboarding API provides access to the details of your onboarding wizards. - [Get a summary of all onboarding wizards.](https://apidocs.hibob.com/reference/get_onboarding-wizards.md): Wizard info includes Wizard ID, name and description.
Supported user types: Service. - [Metadata](https://apidocs.hibob.com/reference/metadata.md): The Matadata API provides access to the details of your company resources. - [Get all employee fields.](https://apidocs.hibob.com/reference/get_company-people-fields.md): This endpoint retrieves only metadata about the employee fields and includes all employee fields. Calling this endpoint does not require any permissions for the service user performing this action.… - [Create a new field.](https://apidocs.hibob.com/reference/post_company-people-fields.md) - [Update an existing field](https://apidocs.hibob.com/reference/put_company-people-fields-fieldid.md) - [Delete an existing field.](https://apidocs.hibob.com/reference/delete_company-people-fields-fieldid.md) - [Get all company lists](https://apidocs.hibob.com/reference/get_company-named-lists.md) - [Get a specific company list by name.](https://apidocs.hibob.com/reference/get_company-named-lists-listname.md) - [Add a new item to an existing list.](https://apidocs.hibob.com/reference/post_company-named-lists-listname.md) - [Update an existing item from a list.](https://apidocs.hibob.com/reference/put_company-named-lists-listname-itemid.md) - [Delete an item from an existing list.](https://apidocs.hibob.com/reference/delete_company-named-lists-listname-itemid.md) - [Employee Tables](https://apidocs.hibob.com/reference/employee-tables.md): The Employee Tables API provides access to the details of your company employees's data tables. - [List work history for a list of employees](https://apidocs.hibob.com/reference/get_bulk-people-work.md): Returns a list of historical work entries from the work table for all employees or a specific list of employees.

**Required permissions**
In order to access the work… - [List the lifecycle history for a list of employees.](https://apidocs.hibob.com/reference/get_bulk-people-lifecycle.md): Returns a list of historical lifecycle entries from the lifecycle table for all employees or a specific list of employees.

**Required permissions**
In order to access… - [List employment history for a list of employees.](https://apidocs.hibob.com/reference/get_bulk-people-employment.md):

Returns a list of historical employment entries from the employment table for all employees or a specific list of employees.

Each employment entry includes the working pattern assigned to… - [List payroll history (salaries) for a list of employees.](https://apidocs.hibob.com/reference/get_bulk-people-salaries.md): Returns a list of historical salary entries from the payroll table for all employees or a specific list of employees.

**Required permissions**
In order to access the… - [List dependents for a list of employees](https://apidocs.hibob.com/reference/get_bulk-people-dependents.md): Returns dependent entries for all employees or a specific list of employees. In the Bob UI this table may appear as Children or Dependents, depending on your company configuration.values uses the same schema as
You can fetch employee IDs using the
**Pagination**
This endpoint uses cursor-based pagination to handle large number of table… - [List employee's work history](https://apidocs.hibob.com/reference/get_people-id-work.md): Returns a list of historical work entries from the work table for an employee.

**Required permissions**
In order to access the work history, the service user making the… - [Create a new work entry for a given employee.](https://apidocs.hibob.com/reference/post_people-id-work.md) - [Update a work entry in the employee's work history table.](https://apidocs.hibob.com/reference/put_people-id-work-entry-id.md): This endpoint updates an entry in the employee’s work history table.
The unique identifier for the work entry is the site and effective date.

Note that the entire work entry will be… - [Deletes a work entry from a given employee's work history.](https://apidocs.hibob.com/reference/delete_people-id-work-entry-id.md) - [List employee's employment history.](https://apidocs.hibob.com/reference/get_people-id-employment.md):

Returns a list of employment history entries for a given employee.

Each employment entry includes the working pattern assigned to this employee. To learn more about working patterns, see

Note that the entire employnebt entry will be overwritten with the data provided in your payload. Any columns not… - [Deletes an employment entry from a given employee's employment history.](https://apidocs.hibob.com/reference/delete_people-id-employment-entry-id.md) - [List employee's lifecycle status history.](https://apidocs.hibob.com/reference/get_people-id-lifecycle.md): Returns a list of historical lifecycle entries from the lifecycle table for an employee.

**Required permissions**
In order to access the lifecycle history, the service… - [List employee's salary history.](https://apidocs.hibob.com/reference/get_people-id-salaries.md): Returns a list of historical salary entries from the salary table in the payroll section for an employee.

**Required permissions**
In order to access the payroll… - [Creates a new salary entry for a given employee.](https://apidocs.hibob.com/reference/post_people-id-salaries.md) - [Deletes a salary entry from the employee's list.](https://apidocs.hibob.com/reference/delete_people-id-salaries-entry-id.md) - [Read payroll tables history.](https://apidocs.hibob.com/reference/get_payroll-history.md): Note: This endpoint is maintained for legacy purposes but is planned for deprecation in the future. We recommend using alternative employee table endpoints where possible. - [List the employee's equity grants.](https://apidocs.hibob.com/reference/get_people-id-equities.md): Returns a list of equity grants for a given employee. - [Creates a new equity grant for a given employee.](https://apidocs.hibob.com/reference/post_people-id-equities.md) - [Updates an equity grant for an employee](https://apidocs.hibob.com/reference/put_people-id-equities-entry-id.md): This endpoint updates an entry in the employee’s equity table.

Important:
The Bank Account details are listed under the 'Financial' category in Bob's UI. They include… - [Create a new bank account entry for a given employee.](https://apidocs.hibob.com/reference/post_people-id-bank-accounts.md) - [Update a bank account entry in the employee's bank accounts table.](https://apidocs.hibob.com/reference/put_people-id-bank-accounts-entry-id.md): This endpoint updates an entry in the employee’s Bank accounts table.
The unique identifier for the bank account entry is the entry id. To obtain the employee's bank account entries use the GET… - [Deletes a bank account entry from a given employee's bank accounts table.](https://apidocs.hibob.com/reference/delete_people-id-bank-accounts-entry-id.md) - [Custom Tables](https://apidocs.hibob.com/reference/custom-tables.md): The Custom Tables API provides access to the details of your company employees's custom tables. - [Read metadata of custom tables defined](https://apidocs.hibob.com/reference/get_people-custom-tables-metadata.md) - [Read metadata for specific custom table](https://apidocs.hibob.com/reference/get_people-custom-tables-metadata-custom-table-id.md) - [Read all entries of the given custom table](https://apidocs.hibob.com/reference/get_people-custom-tables-employee-id-custom-table-id.md) - [Create new custom table entry](https://apidocs.hibob.com/reference/post_people-custom-tables-employee-id-custom-table-id.md): Provide an array of columns and their values. Columns that are defined as **Mandatory** (from the custom column's settings) must be provided.
Values can be any of the **Important**: Although this is a PUT method, it behaves like a PATCH request, meaning you only need to send the fields you want to update, and any… - [Delete custom table entry](https://apidocs.hibob.com/reference/delete_people-custom-tables-employee-id-custom-table-id-entry-id.md) - [Employee data Webhooks](https://apidocs.hibob.com/reference/employee-data-webhooks.md): Receive notificaions about employee updates - [Employee created](https://apidocs.hibob.com/reference/post_webhook_employee-created.md): Triggered when an employee is created. In the right panel, open **Examples** and select **Payload Example** to see a real payload. - [Employee updated](https://apidocs.hibob.com/reference/post_webhook_employee-updated.md): Triggered when an employee's field is updated. The payload includes only the fields that were explicitly changed. Calculated fields affected by an update (e.g., age when birthDate changes) are not… - [Employee deleted](https://apidocs.hibob.com/reference/post_webhook_employee-deleted.md): Triggered when an employee is deleted. The payload includes the employee email so you can retain a reference to the deleted employee after their record is no longer accessible. In the right panel,… - [Employee joined](https://apidocs.hibob.com/reference/post_webhook_employee-joined.md): Triggered when an employee is granted access, once the corresponding lifecycle entry becomes effective. Lifecycle events are triggered automatically at midnight on the effective date of the… - [Employee terminated](https://apidocs.hibob.com/reference/post_webhook_employee-left.md): Triggered when an employee is set as terminated or on Garden leave (whichever occurs first), once the corresponding lifecycle entry becomes effective. Lifecycle events are triggered automatically at… - [Employee activated](https://apidocs.hibob.com/reference/post_webhook_employee-activated.md): Triggered when an employee's access is enabled, once the corresponding lifecycle entry becomes effective. In the right panel, open **Examples** and select **Payload Example** to see a real payload. - [Employee inactivated](https://apidocs.hibob.com/reference/post_webhook_employee-inactivated.md): Triggered when an employee is set to be on leave or terminated, once the corresponding lifecycle entry becomes effective. This event is not triggered if **Remain active** is selected when putting… - [Employee immediate access revocation](https://apidocs.hibob.com/reference/post_webhook_employee-access-revoked-immediately.md): Triggered when a termination flow completes, including all required approvals, with Revoke access immediately selected. Revokes access to Bob itself. In the right panel, open **Examples** and select… - [Employee on temporary leave](https://apidocs.hibob.com/reference/post_webhook_employee-temporary-leave.md): Triggered when an employee is set to be on temporary leave, once the corresponding lifecycle entry becomes effective. This event is not triggered if **Remain active** is selected when putting the… - [Table entry created](https://apidocs.hibob.com/reference/post_webhook_table-entry-created.md): Triggered when an entry is added to an employee's table (including out-of-the-box and custom tables). Does not apply to Training, Equity, Positions, or Jobs tables. To identify the row/entry when… - [Table entry updated](https://apidocs.hibob.com/reference/post_webhook_table-entry-updated.md): Triggered when an entry is updated in an employee's table (including out-of-the-box and custom tables). Does not apply to Training, Equity, Positions, or Jobs tables. To identify the row/entry when… ## API Reference: Time Off API - [Time off requests](https://apidocs.hibob.com/reference/time-off.md): The Time off API provides access to the details of your company time off requests and policies. - [Submit a new time off request.](https://apidocs.hibob.com/reference/post_timeoff-employees-id-requests.md): Submits a new time off request.

Time off requests can be of the listed types in the body params section below.

Each request type requires different parameters in the body… - [Get the details of an existing time off request.](https://apidocs.hibob.com/reference/get_timeoff-employees-id-requests-requestid.md): Retrieve the detailed info about an existing time off request.

Possible time off request types:

days: the request is for X days.

hours: the… - [Cancel an existing time off request](https://apidocs.hibob.com/reference/delete_timeoff-employees-id-requests-requestid.md): Cancels an existing time off request.

**Permissions required**: Please refer to the main Time off API Required… - [Get time off requests changes](https://apidocs.hibob.com/reference/get_timeoff-requests-changes.md): Returns an array of all changes made to time off requests within a specified date range. Each item in the array includes: the time off request details at the time of the change, and the type of… - [Read a list of who's out of the office.](https://apidocs.hibob.com/reference/get_timeoff-whosout.md): Returns time off information for a given date range, only for the users the Service User can access.

Possible time off request types:
- days: the request is for X… - [Read a list of who's out of the office today or on the specified date.](https://apidocs.hibob.com/reference/get_timeoff-outtoday.md): Returns the list of people that have a time off request today or on the specified date, only for the users the Service User can access.
  
  Possible time off request types… - [Time off balance](https://apidocs.hibob.com/reference/time-off-balance.md) - [Get the balance for a given employee](https://apidocs.hibob.com/reference/get_timeoff-employees-id-balance.md): Retrieve the balance for a given employee, for a given policy type, as of a given date.
  
  **Permissions required**: Please refer to the main
  **Permissions required**: Please refer to the main
  **Permissions required**: Please refer to the main Time off… - [Add a list of reason codes for a given policy type.](https://apidocs.hibob.com/reference/post_timeoff-policy-types-policytype-reason-codes.md): Add a list of reason codes for a given policy type.
  Supported user types: Service.
  **Permissions required**: Please refer to the main
  **Permissions required**: Please refer to the main Time off API… - [Get all policy types names.](https://apidocs.hibob.com/reference/get_timeoff-policy-types.md): Get a list of all policy type names.
  
  **Permissions required**: Please refer to the main Time off API Required… - [Get Policy details.](https://apidocs.hibob.com/reference/get_timeoff-policies.md): Get details about a given policy.
  
  **Permissions required**: Please refer to the main Time off API Required… - [Get a list of policy names for a given policy type.](https://apidocs.hibob.com/reference/get_timeoff-policies-names.md): Get a list of policy names for the user's defined policy type.
  
  **Permissions required**: Please refer to the main This endpoint allows you to import attendance punches (entries) for employees.
  Before using this endpoint:
  
  Explore fields parameter are returned. You must provide an employeeId filter and… - [Bulk create attendance entries](https://apidocs.hibob.com/reference/post_attendance-entries.md): Create one or more attendance entries (time log entries) for employees. Entries must match the reporting method (duration or start-end) and rules of the attendance policy linked to the… - [Bulk update attendance entries for an employee](https://apidocs.hibob.com/reference/patch_attendance-employees-employeeid-entries.md): Update one or more attendance entries (time log entries) for a specific employee. Only provided fields are updated. Entries must match the reporting method (duration or start-end) and rules of… - [Clock in (create entry)](https://apidocs.hibob.com/reference/post_attendance-employees-employeeid-entries-clock-in.md): Create a new attendance entry by clocking in the employee identified by the path. Returns the created entry ID. - [Clock out](https://apidocs.hibob.com/reference/patch_attendance-employees-employeeid-entries-clock-out.md): Record clock-out for the employee identified by the path. Updates the most recent open clock-in entry for that employee with the given clock-out time. Returns the updated entry ID. - [Delete an attendance entry](https://apidocs.hibob.com/reference/delete_attendance-entries-entryid.md): Delete an attendance entry by ID. - [Projects](https://apidocs.hibob.com/reference/projects.md): The Projects API provides access to projects in Bob. - [Get Project Metadata](https://apidocs.hibob.com/reference/get_attendance-projects-metadata.md): Returns project fields metadata, including out-of-the-box and custom fields. Use the field ID in fields and filters when calling the Project Tracking:
  
  By Project: Use… - [Update Project](https://apidocs.hibob.com/reference/patch_attendance-projects-projectid.md): Update an existing project with the fields specified in the request body.
  Note: The `/project/status` field cannot be updated via this endpoint. Use project task… - [Search Project Tasks](https://apidocs.hibob.com/reference/post_attendance-project-tasks-search.md): This endpoint allows you to retrieve project task data based on specified filters.
  Explore the Attendance API for more details on usage,… - [Create Project Task(s)](https://apidocs.hibob.com/reference/post_attendance-project-tasks.md): Create one or more project tasks with the specified fields. Supports bulk creation of up to 100 tasks in a single request.
  Note: Tasks are created as `active` by default. To update the… - [Archive Project Task](https://apidocs.hibob.com/reference/patch_attendance-project-tasks-taskid-archive.md): Archive a project task by setting its status to "archived". Archived tasks remain stored and queryable, but are not available for selection when adding new attendance entries. - [Restore Project Task](https://apidocs.hibob.com/reference/patch_attendance-project-tasks-taskid-restore.md): Restore a project task by setting its status to "active". This makes the task available for selection when adding new attendance entries. - [Update Project Task](https://apidocs.hibob.com/reference/put_attendance-project-tasks-taskid.md): Update an existing project task. This endpoint will replace the record with the data in the request payload, so make sure to first read the whole record to avoid data loss.
  Note: The… ## API Reference: Tasks API - [Tasks](https://apidocs.hibob.com/reference/tasks.md): The Tasks API provides access to the details of tasks. - [Read all open tasks.](https://apidocs.hibob.com/reference/get_tasks.md): Returns all open tasks for the company. **Record limit:** This endpoint returns a maximum of 5,000 tasks per request. This is a hard limit and cannot be increased. **No pagination:** This endpoint… - [Read tasks of a specific employee ](https://apidocs.hibob.com/reference/get_tasks-people-id.md) - [Mark a task as complete](https://apidocs.hibob.com/reference/post_tasks-taskid-complete.md) - [Tasks Webhooks](https://apidocs.hibob.com/reference/tasks-webhooks.md): Receive notifications about triggered task lists and tasks status updates. - [Task triggered webhook](https://apidocs.hibob.com/reference/post_webhook_todo-assign.md): Sent when a task list is triggered and one or more general tasks are created. The payload includes `requestedForEmployeeId` (the employee the tasks are for), `workflowId`, `pivotDate`, and `toDoIds`… - [Task status changed webhook](https://apidocs.hibob.com/reference/post_webhook_todo-changed-status.md): Sent when the status of a general task changes (e.g. completed or incomplete). The payload includes `toDoIds`, `toDoRequestedForIds`, `toDoAssigneeIds`, and `newStatus`. Long fields (e.g. description… ## API Reference: Reports API - [Reports](https://apidocs.hibob.com/reference/reports.md): The Reports API provides access to the details of your company reports. - [Read company reports](https://apidocs.hibob.com/reference/get_company-reports.md): Returns a list of all the company reports with their details. The data is filtered based on the access level of the service user making the call. Only viewable categories are returned.
  
  … - [Download the report by ID](https://apidocs.hibob.com/reference/get_company-reports-reportid-download.md): Returns a report data file in the specified format.
  Supported user types: Service.
  
  Permissions required:
  The service user that you use for this call should… - [Get the report download URL for polling](https://apidocs.hibob.com/reference/get_company-reports-reportid-download-async.md): This endpoint asynchronously generates a report, based on the specified format. If successful it returns the status `Accepted` and sets the URL of the newly generated report in the response header… - [Download a report by the report name.](https://apidocs.hibob.com/reference/get_company-reports-download-reportname.md): Downloads the report that was generated with the Get the report download URL for polling endpoint.
  
  To download the report:
  1. Use the [Get the report download URL for… ## API Reference: Docs API - [Documents](https://apidocs.hibob.com/reference/documents.md): The Docs API provides access to the details of your company documents and folders. - [Get list of folders with metadata](https://apidocs.hibob.com/reference/get_docs-folders-metadata.md): Use this endpoint to get the a list of available folders and their metadata, including the folder ID. Use the ID when uploading a file to a specific folder. - [Download list of documents of an employee](https://apidocs.hibob.com/reference/get_docs-people-id.md): Returns a list of documents and download links.
  - [Upload file from a URL to a Shared Folder](https://apidocs.hibob.com/reference/post_docs-people-id-shared.md): Use this endpoint to upload a file from a specified URL directly into a shared folder of a specific employee in Bob.
  
  Make sure you set the right permissions to the Service User in order to… - [Upload file from a URL to a Confidential Folder](https://apidocs.hibob.com/reference/post_docs-people-id-confidential.md): Use this endpoint to upload a file from a specified URL directly into a confidential folder of a specific employee in Bob.
  
  Make sure you set the right permissions to the Service User in order… - [Upload File from a URL to a Custom Folder](https://apidocs.hibob.com/reference/post_docs-people-id-custom-folderid.md): Use this endpoint to upload a file from a specified URL directly into a specific custom folder of a specific employee in Bob.
  
  Make sure you set the right permissions to the Service User in… - [Upload file to a Shared Folder](https://apidocs.hibob.com/reference/post_docs-people-id-shared-upload.md): Use this endpoint to upload a file directly into a shared folder of a specific employee in Bob.
  
  Make sure you set the right permissions to the Service User in order to upload the file. See… - [Upload File to a Confidential Folder](https://apidocs.hibob.com/reference/post_docs-people-id-confidential-upload.md): Use this endpoint to upload a file directly into a confidential folder of a specific employee in Bob.
  
  Make sure you set the right permissions to the Service User in order to upload the file.… - [Upload File to a Custom Folder](https://apidocs.hibob.com/reference/post_docs-people-id-folders-folderid-upload.md): Use this endpoint to upload a file directly into a custom folder of a specific employee in Bob.
  
  Make sure you set the right permissions to the Service User in order to upload the file. See… - [Delete a Document from a Shared Folder](https://apidocs.hibob.com/reference/delete_docs-people-id-shared-docid.md): Use this endpoint to delete a specific document from a shared folder of a specific employee in Bob.
  
  Make sure you set the right permissions to the Service User in order to remove the file.… - [Delete a Document from a Confidential Folder](https://apidocs.hibob.com/reference/delete_docs-people-id-confidential-docid.md): Use this endpoint to delete a specific document from a confidential folder of a specific employee in Bob.
  
  Make sure you set the right permissions to the Service User in order to remove the… - [Delete a Document from a Custom Folder](https://apidocs.hibob.com/reference/delete_docs-people-id-folders-folderid-docid.md): Use this endpoint to delete a specific document from a custom folder of a specific employee in Bob.
  
  Make sure you set the right permissions to the Service User in order to remove the file.… - [Docs Webhooks](https://apidocs.hibob.com/reference/docs-webhooks.md): Receive notifications about documents update - [Document eSign completion webhook](https://apidocs.hibob.com/reference/post_webhook_documents-esign-completed.md): Webhook sent when a document e-signing process is completed. The event will be sent at the end of the signing process. If the request has two signers and only one has signed, the event will not be… ## API Reference: Goals API - [Goals](https://apidocs.hibob.com/reference/goals.md): The Goals API provides access to goals and key results in your company. - [Get Goal Type Metadata](https://apidocs.hibob.com/reference/get_goals-goal-types-metadata.md): Returns the goal type fields. - [Get Goals Metadata](https://apidocs.hibob.com/reference/get_goals-goals-metadata.md): Returns the Goal fields. - [Get Key Results Metadata](https://apidocs.hibob.com/reference/get_goals-goals-key-results-metadata.md): Returns the key result fields. - [Get Goal Cycle Metadata](https://apidocs.hibob.com/reference/get_goals-goal-cycles-metadata.md): Returns the goal cycle fields metadata schema. - [Search Goal Types](https://apidocs.hibob.com/reference/post_goals-goal-types-search.md): Search for the available Goal Types using filters and pagination parameters.
  **Note**: Pagination parameters are currently accepted but not enforced.
  
  **Testing notes:**
  - Use the… - [Search Goals](https://apidocs.hibob.com/reference/post_goals-goals-search.md): Search for Goals using filters and pagination parameters.
  
  **Pagination parameters** are currently accepted but not enforced.
  **Multiple filters** can be combined in a single request. All… - [Search Key Results](https://apidocs.hibob.com/reference/post_goals-goals-key-results-search.md): Search for Key Results of a specific Goals, using filters. The `goalId` filter is mandatory.
  **Note: Pagination parameters are currently accepted but not enforced.**
  
  **Testing notes:**… - [Search Goal Cycles](https://apidocs.hibob.com/reference/post_goals-goal-cycles-search.md): Search for available goal cycles. Returns all goal cycles accessible to the authenticated user.
  
  **Notes**: - Filters are not supported for this endpoint. Providing filters will result in… - [Create Goals](https://apidocs.hibob.com/reference/post_goals-goals.md): Creates multiple goals in a single request using the `items` array.
  Each goal will be created with the specified owner and properties.
  
  **Limitations:**
  - You can create up to 25… - [Update Goal Status](https://apidocs.hibob.com/reference/patch_goals-goals-goalid-status.md): Updates the status of an existing goal, optionally including a comment.
  This endpoint is used to update the status independently from other goal fields such as title, description, or due date.… - [Update Goal](https://apidocs.hibob.com/reference/patch_goals-goals-goalid.md): Update an existing goal details. Supports partial updates where only the fields that are provided in the request body will be updated.
  
  **Cycle Management**: You can assign a goal to a cycle,… - [Delete Goal](https://apidocs.hibob.com/reference/delete_goals-goals-goalid.md): Delete an existing goal. This will permanently remove the goal. This action is irreversible. - [Create Key Results](https://apidocs.hibob.com/reference/post_goals-goals-goalid-key-results.md): Creates one or more key results for a specific goal.
  Each key result will be created with the specified title, `measureBy` properties, and automatically associated with the given goal.
  
  … - [Update Key Results Progress](https://apidocs.hibob.com/reference/patch_goals-goals-goalid-key-results-progress.md): Update the progress (check-in) of one or more key results for a specific goal without changing the goal status.
  
  **Note**: This endpoint behaves like the check-in mechanism in Bob, however, it… - [Update Key Results Details](https://apidocs.hibob.com/reference/patch_goals-goals-goalid-key-results.md): Update the details of the key results of a given goal. This endpoint supports updating the details: title, measureType, target, currency, and currencySymbol fields only. Each key result update is… - [Delete a Key Result](https://apidocs.hibob.com/reference/delete_goals-goals-goalid-key-results-keyresultid.md): Delete a specific key result from a goal. This completely removes the key result.
  **Important:** This action is irreversible. The key result and all its progress history will be permanently… ## API Reference: Skills API - [Skills](https://apidocs.hibob.com/reference/skills.md): Learn how to manage Skills in Bob via the Public API - [Create skills](https://apidocs.hibob.com/reference/post_skills.md): Bulk-create API-origin skills with per-item results. - [Update skills](https://apidocs.hibob.com/reference/patch_skills.md): Bulk-update API-origin skills resolved by source + externalId locator. - [Archive skills](https://apidocs.hibob.com/reference/patch_skills-archive.md): Bulk-archive (soft-delete) API-origin skills by source + externalId locator. - [List proficiency levels](https://apidocs.hibob.com/reference/get_skills-proficiency-levels.md): List the company's proficiency levels, referenced by ID on skill create and update. - [Search skills](https://apidocs.hibob.com/reference/post_skills-search.md): Search API-origin skills with field projection, filters, and cursor pagination. ## API Reference: Job Catalog API - [Job catalog](https://apidocs.hibob.com/reference/job-catalog.md): The Job catalog API provides access to job profiles in your company. - [Read company job profiles](https://apidocs.hibob.com/reference/post_job-catalog-job-profiles-search.md): This endpoint returns a list of company job profiles filtered by the specified attributes. Note that this endpoint requires body parameters, which is why it is implemented as a POST request.
  
  **Required permissions**
  The service user making the call must have the required permissions: see
  
  **Required permissions**
  The service user making the call must have the required permissions: see
  
  **Required permissions**
  The service user making the call must have the required permissions: see
  
  **Required permissions**
  The service user making the call must have the required permissions: see
  
  **Required permissions**
  The service user making the call must have the required permissions: see
  
  **Required permissions**
  The service user making the call must have the required permissions: see
  
  **Required permissions**
  The service user making the call must have the required permissions: see - [Get all positions openings fields](https://apidocs.hibob.com/reference/get_positions-position-openings-metadata.md): Returns a list of all fields of object type position opening.
  - [Get all position budget fields](https://apidocs.hibob.com/reference/get_positions-position-budget-metadata.md): Returns a list of all fields of object type position budget.
  - [Read company positions](https://apidocs.hibob.com/reference/post_objects-position-search.md): This endpoint returns a list of company positions filtered by the specified attributes. Note that this endpoint requires body parameters, which is why it is implemented as a POST request.
  
  **Limitations:**
  - You can create up to 10 positions per request.
  - If the request includes… - [Create Position Opening](https://apidocs.hibob.com/reference/post_workforce-planning-positions-positionid-position-openings.md): Creates a new position opening within a position
  
  **Limitations:**
  - You can create up to 10 position openings per request.
  - If the request includes more than 10 position openings,… - [Update Position](https://apidocs.hibob.com/reference/patch_workforce-planning-positions-positionid.md): Updates an existing position **Notes:**
  - Currently, you cannot use approval flows, which are not supported via the API.
  - This endpoint requires linking the position to a job profile, and… - [Update Position Opening](https://apidocs.hibob.com/reference/patch_workforce-planning-positions-positionid-position-openings-positionopeningid.md): Updates a specific position opening within a position **Notes:**
  - For fields that require reference to a list in Bob, use the - You can create up to 1 budget per request.
  - If the request includes more than 1 budget, the operation will fail and… - [Update Position Budget](https://apidocs.hibob.com/reference/patch_workforce-planning-positions-positionid-position-budget-positionbudgetid.md): Updates a specific position budget within a position - [Schedule Positions Cancellation](https://apidocs.hibob.com/reference/post_workforce-planning-positions-schedule-cancellation.md):
  Schedules the cancellation of one or more positions. This endpoint automatically unassigns any employees connected to the position openings before cancellation.
  
  Note:
  … - [Cancel Position](https://apidocs.hibob.com/reference/patch_workforce-planning-positions-positionid-cancel.md):
  Immediately cancels a position and updates its status to cancelled.
  
  Important: This operation will fail if the position is currently filled (i.e.,… - [Workforce Planning Webhooks](https://apidocs.hibob.com/reference/workforce-planning-webhooks.md): Receive notifications about positions, openings and budgets - [Position created webhook](https://apidocs.hibob.com/reference/post_webhook_workforce-planning-position-created.md): Webhook sent when a new position is created in the Workforce Planning module. Positions are a core entity of the Workforce Planning module, enabling you to allocate budgets and assign specific roles… - [Position updated webhook](https://apidocs.hibob.com/reference/post_webhook_workforce-planning-position-updated.md): Webhook sent when any position fields are modified in the Workforce Planning module. Positions can have various attributes such as department, site, employment type, and manager. The payload… - [Position opening created webhook](https://apidocs.hibob.com/reference/post_webhook_workforce-planning-position-opening-created.md): Webhook sent when a new position opening is created. Position openings are always linked to a Position in Bob. They allow organizations to plan multiple hiring scenarios under the same position… - [Position opening updated webhook](https://apidocs.hibob.com/reference/post_webhook_workforce-planning-position-opening-updated.md): Webhook sent when position opening fields are modified. Position openings are always linked to a Position in Bob. The payload includes `fieldUpdatesIds` to indicate which fields were changed.… - [Position opening deleted webhook](https://apidocs.hibob.com/reference/post_webhook_workforce-planning-position-opening-deleted.md): Webhook sent when a position opening is removed. Position openings are always linked to a Position in Bob. **Best practice:** Use the event as a notification only, and verify the deletion using the… - [Position budget created webhook](https://apidocs.hibob.com/reference/post_webhook_workforce-planning-position-budget-created.md): Webhook sent when a new position budget is created. Position budgets are always linked to a Position in Bob. They allow tracking of the financial allocation for specific roles within the… - [Position budget updated webhook](https://apidocs.hibob.com/reference/post_webhook_workforce-planning-position-budget-updated.md): Webhook sent when position budget fields are modified. Position budgets are always linked to a Position in Bob. They allow tracking of the financial allocation for specific roles within the… ## API Reference: Bob Hiring API - [Job Openings](https://apidocs.hibob.com/reference/job-openings.md): Access job openings in Bob Hiring - [Search job openings](https://apidocs.hibob.com/reference/post_hiring-job-openings-search.md): Searches job openings using filters and returns paginated results.
  
  Use the fields parameter to specify which fields to return
  
  Use the filters… - [Candidates](https://apidocs.hibob.com/reference/candidates.md) - [Search candidates](https://apidocs.hibob.com/reference/post_hiring-candidates-search.md): Searches candidates using filters and returns paginated results.
  
  Use the fields parameter to specify which fields to return
  
  Use the filters parameter… - [Search candidate educations](https://apidocs.hibob.com/reference/post_hiring-candidate-educations-search.md): Searches candidate education records using filters and returns paginated results.
  
  Use the fields parameter to specify which fields to return
  
  Use the… - [Search candidate experiences](https://apidocs.hibob.com/reference/post_hiring-candidate-experiences-search.md): Searches candidate work experience records using filters and returns paginated results.
  
  Use the fields parameter to specify which fields to return
  
  Use the… - [Search candidate languages](https://apidocs.hibob.com/reference/post_hiring-candidate-languages-search.md): Searches candidate language records using filters and returns paginated results.
  
  Use the fields parameter to specify which fields to return
  
  Use the… - [Search candidate skills](https://apidocs.hibob.com/reference/post_hiring-candidate-skills-search.md): Searches candidate skill records using filters and returns paginated results.
  
  Use the fields parameter to specify which fields to return
  
  Use the… - [Search candidate volunteer experiences](https://apidocs.hibob.com/reference/post_hiring-candidate-volunteer-experiences-search.md): Searches candidate volunteer experience records using filters and returns paginated results.
  
  Use the fields parameter to specify which fields to return
  
  Use the… - [Search candidate professional associations memberships](https://apidocs.hibob.com/reference/post_hiring-candidate-professional-associations-memberships-search.md): Searches candidate professional association membership records using filters and returns paginated results.
  
  Use the fields parameter to specify which fields to return
  … - [Search candidate qualifications licenses](https://apidocs.hibob.com/reference/post_hiring-candidate-qualifications-licenses-search.md): Searches candidate qualification and license records using filters and returns paginated results.
  
  Use the fields parameter to specify which fields to return
  
  Use… - [Applications](https://apidocs.hibob.com/reference/applications.md): Access applications in Bob Hiring - [Search applications](https://apidocs.hibob.com/reference/post_hiring-applications-search.md): Searches applications using filters and returns paginated results.
  
  Use the fields parameter to specify which fields to return
  
  Use the filters… - [Search application form answers](https://apidocs.hibob.com/reference/post_hiring-application-form-answers-search.md): Searches application form answer records using filters and returns paginated results.
  
  Use the fields parameter to specify which fields to return
  
  Use the… - [Job ads](https://apidocs.hibob.com/reference/job-ads.md): Job ads API allows you to fetch job ads from Bob's careers page and post them to your custom careers page - [Get all active job ads from your Career page](https://apidocs.hibob.com/reference/post_hiring-job-ads-search.md): Returns an array of active job ads as promoted on the Bob career page.
  
  To learn more about the Hiring API and how to integrate with your career page, see
  To learn more about the Hiring API and how to integrate with your career page, see
  Use the fields parameter to specify which fields to return
  
  Use the filters… - [Search evaluations](https://apidocs.hibob.com/reference/post_hiring-evaluations-search.md): Searches evaluation records using filters and returns paginated results.
  
  Use the fields parameter to specify which fields to return
  
  Use the filters… - [Search evaluation scorecard templates](https://apidocs.hibob.com/reference/post_hiring-evaluation-scorecard-templates-search.md): Searches evaluation scorecard template records using filters and returns paginated results.
  
  Use the fields parameter to specify which fields to return
  
  Use the… - [Offers](https://apidocs.hibob.com/reference/offers.md): Search offer records in Bob Hiring - [Search offers](https://apidocs.hibob.com/reference/post_hiring-offers-search.md): Searches offer records using filters and returns paginated results.
  
  Use the fields parameter to specify which fields to return
  
  Use the filters… ## API Reference: Bob Hiring Partners API - [Background checks](https://apidocs.hibob.com/reference/background-checks.md): Register packages and report background check status for Bob Hiring partners - [Register background check packages](https://apidocs.hibob.com/reference/post_hiring-background-checks-packages.md): Replace the partner package catalog for the installing company. - [Delete background check packages](https://apidocs.hibob.com/reference/post_hiring-background-checks-packages-delete.md): Permanently delete specific packages from the partner catalog for the installing company. - [Get background check details](https://apidocs.hibob.com/reference/get_hiring-background-checks-backgroundcheckrequestid.md): Fetch candidate, requester, job opening, and package context for a triggered background check. - [Update background check status](https://apidocs.hibob.com/reference/patch_hiring-background-checks-backgroundcheckrequestid.md): Report status, result, PDF report, and per-step check progress back to Bob. ## API Reference: Partner Assessments API - [Assessments](https://apidocs.hibob.com/reference/assessments.md) - [Register assessment packages](https://apidocs.hibob.com/reference/post_hiring-assessments-packages.md): Replace the partner package catalog for the installing company. - [Delete assessment packages](https://apidocs.hibob.com/reference/post_hiring-assessments-packages-delete.md): Permanently delete specific packages from the partner catalog for the installing company. - [Get assessment details](https://apidocs.hibob.com/reference/get_hiring-assessments-assessmentrequestid.md): Fetch candidate, requester, job opening, and package context for a triggered assessment. - [Update assessment status](https://apidocs.hibob.com/reference/patch_hiring-assessments-assessmentrequestid.md): Report status, score, verdict, result URL, and section breakdown back to Bob. ## API Reference: Bob Learning API - [Provider integrations](https://apidocs.hibob.com/reference/provider-integrations.md): Use the Bob Learning API to add course providers and training content - [Create integration](https://apidocs.hibob.com/reference/post_learning-lms-integrations.md): Registers a new LMS integration for the company. Once created, use the `providerIdentifier` as the `provider-identifier` path parameter to push training content and submit learner progress. **Before… - [Delete integration (soft delete)](https://apidocs.hibob.com/reference/delete_learning-lms-integrations-provider-identifier.md): Removes the LMS integration for the given provider. The integration is soft-deleted — the record is marked as inactive rather than permanently removed. Returns `404` if the integration does not exist… - [Create training content (bulk insert)](https://apidocs.hibob.com/reference/post_learning-lms-integrations-provider-identifier-training-content.md): Creates one or more training content items for the integration in a single request (up to 500 items per call). Each item requires a unique `/trainingContent/externalIdentifier` and a… - [Update training content (bulk patch)](https://apidocs.hibob.com/reference/patch_learning-lms-integrations-provider-identifier-training-content.md): Updates one or more existing training content items. Only the fields you include in the request are changed — fields you omit remain as they are. Use `/trainingContent/externalIdentifier` in each… - [Archive training content (bulk)](https://apidocs.hibob.com/reference/patch_learning-lms-integrations-provider-identifier-training-content-archive.md): Marks one or more training content items as archived. Archived items are hidden from learners but the records are not permanently deleted. Returns `200 OK` with a `success` array of archived… - [Submit xAPI statement](https://apidocs.hibob.com/reference/post_learning-lms-integrations-provider-identifier-xapi-statements.md): Submits a single xAPI statement to record learner progress for a course. On success, returns `200 OK` with `accepted: true` and the echoed `statementId`. Submitting the same statement `id` (UUID)… ## API Reference: Retirement Partners API - [Connection](https://apidocs.hibob.com/reference/connection.md): Verify Retirement Partners API reachability for the authenticated caller. - [Get connection status](https://apidocs.hibob.com/reference/get_payroll-hub-us-connection-status.md): Verify Retirement Partners API reachability for the authenticated caller. - [Deductions](https://apidocs.hibob.com/reference/deductions.md): List, create, and update employee deductions. Changes apply from the next pay cycle. - [List employee deductions](https://apidocs.hibob.com/reference/get_payroll-hub-us-employers-employerid-employees-deductions.md): Read current deductions for a batch of employees under an employer. - [Create employee deduction](https://apidocs.hibob.com/reference/post_payroll-hub-us-employers-employerid-employees-employeeid-deductions.md): Create a new deduction for an employee, applied from the next pay cycle. - [Update employee deduction](https://apidocs.hibob.com/reference/put_payroll-hub-us-employers-employerid-employees-employeeid-deductions-deductionid.md): Update an existing deduction by ID; changes apply from the next pay cycle. - [Employees](https://apidocs.hibob.com/reference/employees.md): Fetch payroll-relevant employee census fields in batches by Bob employee ID. - [Get employee census data](https://apidocs.hibob.com/reference/get_payroll-hub-us-employees.md): Fetch payroll-related profile fields for a batch of Bob employees. - [Employers](https://apidocs.hibob.com/reference/employers-payroll.md): Discover US employers linked to the authenticated company for Retirement Partners integrations. - [List employers](https://apidocs.hibob.com/reference/get_payroll-hub-us-employers.md): Discover US employers linked to the authenticated company. - [List employer deduction plans](https://apidocs.hibob.com/reference/get_payroll-hub-us-employers-employerid-deduction-plans.md): Retrieve employer-level deduction plans for partner onboarding and configuration. - [List employer employees](https://apidocs.hibob.com/reference/get_payroll-hub-us-employers-employerid-employees.md): Retrieve an employer's employee roster for partner onboarding. - [List employer pay codes](https://apidocs.hibob.com/reference/get_payroll-hub-us-employers-employerid-pay-codes.md): Retrieve earnings pay codes for an employer to support partner mapping during onboarding. - [Retirement Partners Webhooks](https://apidocs.hibob.com/reference/retirement-partners-webhooks.md): Server-to-partner webhooks fired when a US pay cycle is paid. - [Pay cycle paid](https://apidocs.hibob.com/reference/post_webhook_payroll-paycycle-paid.md): **Beta.** Sent when a US pay cycle is completed and paycheck data is available for partner processing. Use `data.payCycleId` with [`GetPayCycle`](/reference/get_payroll-hub-us-pay-cycles-paycycleid)… - [Pay codes](https://apidocs.hibob.com/reference/pay-codes.md): Reference list of standard US payroll pay codes used during partner onboarding. - [List pay codes](https://apidocs.hibob.com/reference/get_payroll-hub-us-pay-codes.md): Retrieve the curated list of standard US payroll pay codes. - [Pay cycles](https://apidocs.hibob.com/reference/pay-cycles.md): Discover pay cycles for an employer, fetch a cycle by ID, and list its paychecks. - [List pay cycles for employer](https://apidocs.hibob.com/reference/get_payroll-hub-us-employers-employerid-pay-cycles.md): Discover pay cycles for an employer, with optional date filters and cursor pagination. - [Get pay cycle by ID](https://apidocs.hibob.com/reference/get_payroll-hub-us-pay-cycles-paycycleid.md): Fetch a single pay cycle's metadata by ID. - [List paychecks for pay cycle](https://apidocs.hibob.com/reference/get_payroll-hub-us-pay-cycles-paycycleid-paychecks.md): Read employee paychecks for a paid pay cycle, filtered to the caller's authorized employees. ## API Reference: Applicant API - [Applicants](https://apidocs.hibob.com/reference/applicants.md) - [Create an applicant](https://apidocs.hibob.com/reference/post_external-hires-applicants.md): Submits a hired candidate into Bob as a pending hire. The record is added to ATS Pending Hires; an employee is created only after HR activates the New Hire flow. Only fields that are part of that New…