This endpoint allows you to import attendance punches (entries) for employees.
- Explore Import attendance punches into Bob via Public API for detailed information about this endpoint.
- It's important to fully understand how to use this endpoint correctly to avoid errors in the import process.
- [Fetch attendance summaries](https://apidocs.hibob.com/reference/post_attendance-summaries-search.md): This endpoint returns aggregated attendance summary metrics for one or more employees within a specified date range. Results are returned as a summary per employee per date range and can include total worked hours, payable hours, overtime, breaks, and other attendance metrics (based on the fields you request). This is a read operation that uses POST because it requires a structured request body (filters, field selection, and pagination parameters). Before using this endpoint:
- Explore the Attendance API for more details on usage, rate limits, permissions, and more.
- You must provide both `dateRange` and `employeeId` filters in the request.
- Only fields mentioned in the `fields` parameter are returned in the response.
- Pagination: Use `limit` and `cursor` parameters to paginate through results. The `cursor` value for the next page is returned in `response_metadata.next_cursor`. To learn more, see Pagination in Bob's API.
Testing notes:
- Use the testing widget's Try It! option to test this endpoint.
- Use the Examples > Request Example option to see how to initiate body parameters.
- [Get Project Client Metadata](https://apidocs.hibob.com/reference/get_attendance-project-clients-metadata.md): Returns the project client fields (out-of-the-box only) fields and custom fields. Use the field ID in fields and filters when calling the project client search endpoint.
- [Get Project Task Metadata](https://apidocs.hibob.com/reference/get_attendance-project-tasks-metadata.md): Returns the project task fields (out-of-the-box only). Use the field ID in fields and filters when calling the project task search endpoint.
- [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 search endpoint. Important Note: Custom fields of the following types are not supported via the API: - Multi-select list
- List
- Document
- [Projects](https://apidocs.hibob.com/reference/projects.md): The Projects API provides access to projects in Bob.
- [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.
- [Archive Project](https://apidocs.hibob.com/reference/patch_attendance-projects-projectid-archive.md): Archive a project by setting its status to "archived". Archived projects remain stored and queryable, but are not available for selection when adding new attendance entries.
- [Restore Project](https://apidocs.hibob.com/reference/patch_attendance-projects-projectid-restore.md): Restore a project by setting its status to "active". This makes the project available for selection when adding new attendance entries.
- [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 archive/restore endpoints instead.
Testing notes:
- Use the testing widget's Try It! option to test this endpoint.
- Use the Examples > Request Example option to see how to initiate body parameters.
- For custom fields, use the Examples > Request Example > Update project with fields and copy to an external API client tool to change parameters.
- [Search Project Clients](https://apidocs.hibob.com/reference/post_attendance-project-clients-search.md): This endpoint allows you to retrieve project client data based on specified filters. Please note that this endpoint requires body parameters, which is why it utilizes a POST request for a read operation. Before using this endpoint:
- Explore the Attendance API for more details on usage, rate limits, permissions, and more.
- Only project client fields mentioned in the `fields` parameter are returned. Use project client metadata endpoint to get the field IDs.
- Pagination note: Pagination parameters are currently accepted but not enforced. The response includes all matching results regardless of the `limit` or `cursor` values. Pagination will be implemented in a future version to limit results per page. To learn more, see Pagination in Bob’s API.
Testing notes:
- Use the testing widget's Try It! option to test this endpoint.
- Use the Examples > Request Example option to see how to initiate body parameters.
- [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, rate limits, permissions, and more.
Notes:
- Only project task fields mentioned in the `fields` parameter are returned. Use project task metadata endpoint to get the field IDs.
- By default, only active project tasks will be retrieved. To fetch archived tasks, filter by `status` equals `archived`.
- Pagination parameters are currently accepted but not enforced. The response includes all matching results regardless of the `limit` or `cursor` values. Pagination will be implemented in a future version to limit results per page. To learn more, see Pagination in Bob’s API.
- This endpoint requires body parameters, which is why it utilizes a POST request for a read operation.
Testing notes:
- Use the testing widget's Try It! option to test this endpoint.
- Use the Examples > Request Example option to see how to initiate body parameters.
- [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 status, use archive/restore endpoints
Testing notes:
- Use the testing widget's Try It! option to test this endpoint.
- Use the Examples > Request Example option to see how to initiate body parameters.
- [Search Projects](https://apidocs.hibob.com/reference/post_attendance-projects-search.md): This endpoint allows you to retrieve project data based on specified filters. Please note that this endpoint requires body parameters, which is why it utilizes a POST request for a read operation. Before using this endpoint:
- Explore the Attendance API for more details on usage, rate limits, permissions, and more.
- Only project fields mentioned in the `fields` parameter are returned. Use project metadata endpoint to get the field IDs.
- Pagination note: Pagination parameters are currently accepted but not enforced. The response includes all matching results regardless of the `limit` or `cursor` values. Pagination will be implemented in a future version to limit results per page. To learn more, see Pagination in Bob’s API.
Testing notes:
- Use the testing widget's Try It! option to test this endpoint.
- Use the Examples > Request Example option to see how to initiate body parameters.
- [Create Project(s)](https://apidocs.hibob.com/reference/post_attendance-projects.md): Create one or more projects with the specified fields. Supports bulk creation of up to 100 projects in a single request. Project Tracking:
- By Project: Use `/project/billable` field, do not pass `/project/taskIds`
- By Task: Use `/project/taskIds` field, do not pass `/project/billable`
Note: Projects are created as `active` by default. To update the status, use archive/restore endpoints
Testing notes:
- Use the testing widget's Try It! option to test this endpoint.
- Use the Examples > Request Example option to see how to initiate body parameters.
- For custom fields, use the Examples > Request Example > Create project with custom fields and copy to an external API client tool to change parameters.
- [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 `/projectTask/status` field cannot be updated via this endpoint. Use archive/restore endpoints instead.
Testing notes:
- Use the testing widget's Try It! option to test this endpoint.
- Use the Examples > Request Example option to see how to initiate body parameters.
- [Get the details of a single job ad](https://apidocs.hibob.com/reference/get_hiring-job-ads-id.md): Returns the details of the job ad that was promoted on the Bob careers page.
To learn more about the Hiring API and how to integrate with your career page, see How to integrate with your careers page
- [Hiring](https://apidocs.hibob.com/reference/hiring.md): Bob's Hiring 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 How to integrate with your careers page
- [Authorization](https://apidocs.hibob.com/reference/authorization.md): How to build the authorization header when sending HTTP calls to Bob.
- [Error handling](https://apidocs.hibob.com/reference/error-handling.md): Learn how Bob's public APIs handle errors
- [Object-based endpoints](https://apidocs.hibob.com/reference/object-based-endpoints.md): Learn about the new object-based endpoints in our public API
- [Pagination](https://apidocs.hibob.com/reference/pagination-1.md): Bob offers cursor-based pagination for some of our API’s collection endpoints.
- [Permissions](https://apidocs.hibob.com/reference/permissions.md): Learn about setting service user permissions to access the data in Bob
- [Rate limiting](https://apidocs.hibob.com/reference/rate-limiting.md): Learn how we limit access to endpoints and to our server
- [Testing](https://apidocs.hibob.com/reference/testing.md): Learn how to test endpoints using your own data
- [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 file. See more details in How to set up permissions for People's Docs .
- [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. See more details in How to set up permissions for People's Docs .
- [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. See more details in How to set up permissions for People's Docs .
- [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.
- [Documents](https://apidocs.hibob.com/reference/documents.md): The Docs API provides access to the details of your company documents and folders.
- [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. See more details in How to set up permissions for People's Docs .
- [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 to upload the file. See more details in How to set up permissions for People's Docs .
- [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 order to upload the file. See more details in How to set up permissions for People's Docs .
- [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 more details in How to set up permissions for People's Docs .
- [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 more details in How to set up permissions for People's Docs .
- [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 the file. See more details in How to set up permissions for People's Docs .
- [Delete custom table entry](https://apidocs.hibob.com/reference/delete_people-custom-tables-employee-id-custom-table-id-entry-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)
- [Read metadata for specific custom table](https://apidocs.hibob.com/reference/get_people-custom-tables-metadata-custom-table-id.md)
- [Read metadata of custom tables defined](https://apidocs.hibob.com/reference/get_people-custom-tables-metadata.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.
- [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 supported field types.
**Note**: You can use **Examples > Request Example** option for a basic example, however, we recommend that you copy the endpoint to Postman and test more complicated structures using the JSON editor.
- [Update custom table entry.](https://apidocs.hibob.com/reference/put_people-custom-tables-employee-id-custom-table-id-entry-id.md): Provide an array of columns and their values.
**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 other fields will remain unchanged.
Values can be any of the supported field types.
**Note**: You can use **Examples > Request Example** option for a basic example, however, we recommend that you copy the endpoint to Postman and test more complicated structures using the JSON editor.
- [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)
- [Deletes an employment entry from a given employee's employment history.](https://apidocs.hibob.com/reference/delete_people-id-employment-entry-id.md)
- [Deletes an equity grant for an employee.](https://apidocs.hibob.com/reference/delete_people-id-equities-entry-id.md)
- [Deletes a salary entry from the employee's list.](https://apidocs.hibob.com/reference/delete_people-id-salaries-entry-id.md)
- [Deletes any training records for an employee.](https://apidocs.hibob.com/reference/delete_people-id-training-entry-id.md)
- [Deletes a variable payment record for an employee.](https://apidocs.hibob.com/reference/delete_people-id-variable-entry-id.md)
- [Deletes a work entry from a given employee's work history.](https://apidocs.hibob.com/reference/delete_people-id-work-entry-id.md)
- [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 this employee. To learn more about working patterns, see How to work with Working patterns.
Required permissions
In order to access the employment history of each requested employee, the service user making the call must have the following permissions:
- For all the employment table entries: People's Data > Employment > View selected employees' Employment section histories.
- For the current effective employment entry only: People's Data > Employment > View selected employees' Employment sections.
- For the employees: People's Data > Access data for: Make sure the employees are in the list. Employees that are not listed and were specifically requested will be listed under `errors` in the response.
Pagination
This endpoint uses cursor-based pagination to handle large number of table entries. To learn more, see Pagination in Bob's API.
- [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 the lifecycle history of each requested employee, the service user making the call must have the following permissions:
**For all the lifecycle table entries**: People's Data > Lifecycle > View selected employees' Lifecycle section histories.
**For the current effective lifecycle entry only**: People's Data > Lifecycle > View selected employees' Lifecycle sections.
**For the employees**: People's Data > Access data for > Make sure the employees are in the list. Employees that are not listed and were specifically requested will be listed under `errors` in the response.
**Pagination**
This endpoint uses cursor-based pagination to handle large number of table entries. To learn more, see Pagination in Bob's API
- [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 payroll history of each requested employee, the service user making the call must have the following permissions:
**For all the salary table entries**: People's Data > Payroll > View selected employees' Payroll section histories.
**For the current effective salary entry only**: People's Data > Payroll > View selected employees' Payroll sections.
**For the employees**: People's Data > Access data for > Make sure the employees are in the list. Employees that are not listed and were specifically requested will be listed under `errors` in the response.
**Pagination**
This endpoint uses cursor-based pagination to handle large number of table entries. To learn more, see Pagination in Bob's API
- [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 history of each requested employee, the service user making the call must have the following permissions:
**For all the work table entries**: People's Data > Work > View selected employees' Work section histories.
**For the current effective work entry only**: People's Data > Work > View selected employees' Work sections.
**For the employees**: People's Data > Access data for > Make sure the employees are in the list. Employees that are not listed and were specifically requested will be listed under `errors` in the response.
**Pagination**
This endpoint uses cursor-based pagination to handle large number of table entries. To learn more, see Pagination in Bob's API
- [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 employee's bank accounts](https://apidocs.hibob.com/reference/get_people-id-bank-accounts.md): Returns a list of the bank accounts table entries for a given employee.
Important:
The Bank Account details are listed under the 'Financial' category in Bob's UI. They include basic bank account details, and may include also a list of bank accounts (if using more than a single bank account).
If you are using a list of Bank Accounts:
Use this endpoint will fetch the list of bank accounts.
Use the Read metadata for specific custom table endpoint and provide the table name: `bankAccounts` to fetch the table's metadata.
If you are using only a single Bank Account:
To fetch the basic bank account details (not the table), use the employee's search endpoint instead, and specify the fields you want to fetch (e.g. 'financial.bankName'). To learn more, see how to work with Fields, Custom fields and Lists.
See the '200' response for the body response.
- [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 How to work with Working patterns.
Required permissions
- For all the employment table entries: People's Data > Employment > View selected employees' Employment section histories.
- For the current effective employment entry only: People's Data > Employment > View selected employees' Employment sections.
- For the employees: People's Data > Access data for: Make sure the employees are in the list. Employees that are not listed and were specifically requested will be listed under `errors` in the response.
- [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.
- [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 user making the call must have the following permissions:
**For all the lifecycle table entries**: People's Data > Lifecycle > View selected employees' Lifecycle section histories.
**For the current effective lifecycle entry only**: People's Data > Lifecycle > View selected employees' Lifecycle sections.
**For the employees**: People's Data > Access data for > Make sure the employee is in the list.
- [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 history, the service user making the call must have the following permissions:
**For all the salary table entries**: People's Data > Payroll > View selected employees' Payroll section histories.
**For the current effective salary entry only**: People's Data > Payroll > View selected employees' Payroll sections.
**For the employee**: People's Data > Access data for > Make sure the employee is in the list.
- [List the employee's training records.](https://apidocs.hibob.com/reference/get_people-id-training.md): Returns a list of training entries from the employee's Training table, for a given employee.
- [List employee's variable payments](https://apidocs.hibob.com/reference/get_people-id-variable.md): Returns a list of variable payments for a given employee.
**Required permissions**
In order to access the work history, the service user making the call must have the following permissions:
**For all the work table entries**: People's Data > Work > View selected employees' Work section histories.
**For the current effective work entry only**: People's Data > Work > View selected employees' Work sections.
**For the employee**: People's Data > Access data for > Make sure the employee is in the list.
- [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.
- [Search for actual payments](https://apidocs.hibob.com/reference/post_people-actual-payments-search.md): This endpoint allows you to search for actual payments based on various filters.
**Pagination**
This endpoint uses cursor-based pagination to handle large number of table entries. To learn more, see Pagination in Bob's API
Required permissions
**For all the actual payments table entries**: People's Data > Payroll > View selected employees' Payroll section histories.
**For the employees**: People's Data > Access data for > Make sure the employees are in the list. Employees that are not listed and were specifically requested will be listed under `errors` in the response.
**Testing notes**:
1. Use the testing widget's **Try It!** option to test this endpoint.
2. Request Example: Use the **Examples > Request example** option to see how to initiate body parameters.
3. **To test more than a single filter**, copy the example to an external API testing app like Postman for better filtering options.
4. Response Example: View the response payload using the **Response > Response example** option in the response on the right.
- [Create a new bank account entry for a given employee.](https://apidocs.hibob.com/reference/post_people-id-bank-accounts.md)
- [Creates a new employment entry for a given employee.](https://apidocs.hibob.com/reference/post_people-id-employment.md)
- [Creates a new equity grant for a given employee.](https://apidocs.hibob.com/reference/post_people-id-equities.md)
- [Creates a new salary entry for a given employee.](https://apidocs.hibob.com/reference/post_people-id-salaries.md)
- [Creates a new training records for a given employee](https://apidocs.hibob.com/reference/post_people-id-training.md): Create a new training record in the Training table. Follow the parameters description for more details on the values to pass to this endpoint.
- [Creates a new variable payment for a given employee.](https://apidocs.hibob.com/reference/post_people-id-variable.md)
- [Create a new work entry for a given employee.](https://apidocs.hibob.com/reference/post_people-id-work.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 /people/{employee-id}/bank-accounts endpoint.
**Notes**:
1. **Out-of-the-box columns**: These columns will be completely overwritten with the data provided in your payload. Any columns not included in the payload will be cleared (set to empty values). 2. **Custom columns**: These columns will remain unchanged unless explicitly included in the payload.
- [Update an employment entry from a given employee's employment history.](https://apidocs.hibob.com/reference/put_people-id-employment-entry-id.md): This endpoint updates an entry in the employee’s employment history table.
Note that the entire employnebt entry will be overwritten with the data provided in your payload. Any columns not included in the payload will be cleared (set to empty values).
- [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.
Note that the entire equities entry will be overwritten with the data provided in your payload. Any columns not included in the payload will be cleared (set to empty values).
- [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 overwritten with the data provided in your payload. Any columns not included in the payload will be cleared (set to empty values).
Patch Update Flag:
As a best practice, we recommend reading the entire work entry data, updating the necessary fields, and then writing back the entire entry. However, for legacy purposes, we provide the flag: patchUpdate=true, which functions similarly to a PATCH request.
When using this flag, please note:
1. Only the fields included in the payload will be updated; all others will remain unchanged.
2. The identifier for the work entry should be entry_id, not the site/effective date.
3. Note that using the patchUpdate approach is not recommended and should be reserved for legacy implementations only.
- [Delete an item from an existing list.](https://apidocs.hibob.com/reference/delete_company-named-lists-listname-itemid.md)
- [Delete an existing field.](https://apidocs.hibob.com/reference/delete_company-people-fields-fieldid.md)
- [Get a specific company list by name.](https://apidocs.hibob.com/reference/get_company-named-lists-listname.md)
- [Get all company lists](https://apidocs.hibob.com/reference/get_company-named-lists.md)
- [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.
However, fetching the actual data requires setting the relevant permissions for the service user, including permissions to access employee data and relevant categories.
To learn more, see Search for employees .
- [Metadata](https://apidocs.hibob.com/reference/metadata.md): The Matadata API provides access to the details of your company resources.
- [Add a new item to an existing list.](https://apidocs.hibob.com/reference/post_company-named-lists-listname.md)
- [Create a new field.](https://apidocs.hibob.com/reference/post_company-people-fields.md)
- [Update an existing item from a list.](https://apidocs.hibob.com/reference/put_company-named-lists-listname-itemid.md)
- [Update an existing field](https://apidocs.hibob.com/reference/put_company-people-fields-fieldid.md)
- [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.
- [Onboarding](https://apidocs.hibob.com/reference/onboarding.md): The Onboarding API provides access to the details of your onboarding wizards.
- [Read avatar for an employee ID.](https://apidocs.hibob.com/reference/get_avatars-employeeid.md): Returns the avatar image URL of the employee.
- [Read avatar for an employee email](https://apidocs.hibob.com/reference/get_avatars.md): Returns the avatar image URL of the employee.
- [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 necessary permissions to access all the users and fields you want to retrieve, including the vasic default fields permissions.
Explore the People API main reference page for information about rate limits, permissions, troubleshooting and more.
- [People](https://apidocs.hibob.com/reference/people.md): The People API provides access to the details of your company employees.
- [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.
- [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 for information about rate limits, permissions, troubleshooting and more.
- [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.
- [Read company employee fields by employee ID.](https://apidocs.hibob.com/reference/post_people-identifier.md): This endpoint allows you to retrieve employee data based on specified criteria.
Please note that this endpoint requires body parameters, which is why it utilizes a POST request for a read operation. **Before using this endpoint:**
- **Explore the People API main reference page** for information about rate limits, permissions, troubleshooting and more.
- **Note that only employee fields are supported**. Table entries cannot be retrieved via this endpoint. Use Employee Tables endpoints for this.
- **Default fields**. If no specific fields are requested, a **default set** of fields will be returned, as listed in the 200 response, based on the service user permissions. If you want to retrieve other fields, you will need to specify their field id in the body parameters.
- **Custom fields**. To retrieve custom fields you need to specify their field id in the body parameters and ensure you have the approriate permissions to the category.
- **Position** fields cannot be retrieved using this endpoint. To pull 'Positions', use the Workforce Planning endpoints.
**Testing notes**:
- Use the testing widget's **Try It!** option to test this endpoint.
- Use the **Examples > Request Example** option to see how to initiate body parameters.
- Explore the response payload using the **Example** in the Response on the right, to understand the structure. You can see the response for the human-readable format and for the machine-format (backend IDs).
- [Search for employees](https://apidocs.hibob.com/reference/post_people-search.md): This endpoint allows you to retrieve employee data based on specified criteria.
Please note that this endpoint requires body parameters, which is why it utilizes a POST request for a read operation. **Before using this endpoint:**
- **Explore the People API main reference page** for information about rate limits, permissions, troubleshooting and more.
- **Note that only employee fields are supported**. Table entries cannot be retrieved via this endpoint. Use Employee Tables endpoints for this.
- **Default fields**. If no specific fields are requested, a **default set** of fields will be returned, as listed in the 200 response, based on the service user permissions. If you want to retrieve other fields, you will need to specify their field id in the body parameters.
- **Custom fields**. To retrieve custom fields you need to specify their field id in the body parameters and ensure you have the approriate permissions to the category.
- **Position** fields cannot be retrieved using this endpoint. To pull 'Positions', use the Workforce Planning endpoints.
**Testing notes**:
- Use the testing widget's **Try It!** option to test this endpoint.
- Use the **Examples > Request Example** option to see how to initiate body parameters.
- Explore the response payload using the **Example** in the Response on the right, to understand the structure. You can see the response for the human-readable format and for the machine-format (backend IDs).
- [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` and `startDate`.
While not all fields are mandatory, we recommend populating as many fields as possible to ensure complete employee records from the start.
Specifically, it's recommended to include `work.department` and `work.title`.
You can include **any additional fields** from the [Fields Metadata API](https://apidocs.hibob.com/reference/get_company-people-fields) to enrich the employee's profile during creation.
- [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.
- [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 fields you want to update, and any other fields will remain unchanged.
**Before using this endpoint**, read the instructions on how to update employee data. You can find them here: Update Employee data.
**Notes**: - Only employee **fields** are supported; table updates are not allowed via this endpoint.
- **Position** fields cannot be updated using this endpoint.
- [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 deleted.
- [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.
- [Get Goal Cycle Metadata](https://apidocs.hibob.com/reference/get_goals-goal-cycles-metadata.md): Returns the goal cycle fields metadata schema.
- [Get Goal Type Metadata](https://apidocs.hibob.com/reference/get_goals-goal-types-metadata.md): Returns the goal type fields.
- [Get Key Results Metadata](https://apidocs.hibob.com/reference/get_goals-goals-key-results-metadata.md): Returns the key result fields.
- [Get Goals Metadata](https://apidocs.hibob.com/reference/get_goals-goals-metadata.md): Returns the Goal fields.
- [Goals](https://apidocs.hibob.com/reference/goals.md): The Goals API provides access to goals and key results in your company.
- [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 maintains the current goal status, updating only the key result progress. To update the goal status, use the Update Goal Status endpoint.
This endpoint supports optional audit fields at both levels: goal-level comment and key result-level notes. These parameters only affect check-in activity log for auditing purposes. They are not part of the Goal or Key Result entities, and are not returned by search/metadata endpoints.
- [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 processed independently with individual success/failure tracking.
**Note:** To update the key result progress (check-in), use the `/goals/goals/{goalId}/key-results/progress` endpoint.
- [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.
**Note**: In Bob, status changes are performed through a dedicated workflow (e.g., goal check-ins), which is why this action is exposed via a separate endpoint.
- [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, move it between cycles, or unassign it from a cycle using the `cycleId` field: - To assign to a cycle: provide a valid cycle ID - To move between cycles: provide a different cycle ID - To unassign from a cycle: provide `null` as the value - To keep the current cycle: omit the field entirely
**Note**: Goal status updates are not supported via this endpoint. Use the Update Goal Status endpoint instead.
- [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 a 400 error. - Pagination parameters are currently accepted but not enforced. **Testing notes:**
- Use the testing widget's **Try It!** option to test this endpoint.
- Use the **Examples > Request Example** option to see how to initiate body parameters.
- [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 testing widget's **Try It!** option to test this endpoint.
- Use the **Examples > Request Example** option to see how to initiate body parameters.
- [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.
**Limitations:**
- You can create up to 25 key results per request.
- If the request includes more than 25 items, it will return a 400 error.
The response includes an array of the created key result IDs.
If any key result fails to be created, a structured error response will be returned with details for each failed item.
**Testing notes:**
- Use the testing widget's **Try It!** option to test this endpoint.
- Use the **Examples > Request Example** option to see how to initiate body parameters.
- [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:**
- Use the testing widget's **Try It!** option to test this endpoint.
- Use the **Examples > Request Example** option to see how to initiate body parameters.
- [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 filters use AND logic (goals must match ALL specified filters).
**Testing notes:**
- Use the testing widget's **Try It!** option to test this endpoint.
- Use the **Examples > Request Example** option to see how to initiate body parameters.
- [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 goals per request.
- If the request includes more than 25 goals, the operation will fail and return an error.
The response includes an array of the created Goal IDs.
If any key result fails to be created, a structured error response will be returned with details for each failed item.
**Testing notes:**
- Use the testing widget's **Try It!** option to test this endpoint.
- Use the **Examples > Request Example** option to see how to initiate body parameters.
- [Get job family metadata](https://apidocs.hibob.com/reference/get_job-catalog-job-families-metadata.md): Returns a list of all fields of object type job family.
**Required permissions**
The service user making the call must have the required permissions: see Permissions required.
- [Get all job families](https://apidocs.hibob.com/reference/get_job-catalog-job-families.md): Returns a list of all objects of type job family.
**Required permissions**
The service user making the call must have the required permissions: see Permissions required.
**Pagination**
This endpoint uses cursor-based pagination to handle large number of table entries. To learn more, see Pagination in Bob's API
- [Get job family group metadata](https://apidocs.hibob.com/reference/get_job-catalog-job-family-groups-metadata.md): Returns a list of all fields of object type job family group.
**Required permissions**
The service user making the call must have the required permissions: see Permissions required.
- [Get all job family groups](https://apidocs.hibob.com/reference/get_job-catalog-job-family-groups.md): Returns a list of all objects of type job family group.
**Required permissions**
The service user making the call must have the required permissions: see Permissions required.
**Pagination**
This endpoint uses cursor-based pagination to handle large number of table entries. To learn more, see Pagination in Bob's API
- [Get job profiles metadata](https://apidocs.hibob.com/reference/get_job-catalog-job-profiles-metadata.md): Returns a list of all fields of object type job profile.
**Required permissions**
The service user making the call must have the required permissions: see Permissions required.
- [Get job role metadata](https://apidocs.hibob.com/reference/get_job-catalog-job-roles-metadata.md): Returns a list of all fields of object type job role.
**Required permissions**
The service user making the call must have the required permissions: see Permissions required.
- [Get all job roles](https://apidocs.hibob.com/reference/get_job-catalog-job-roles.md): Returns a list of all objects of type job role.
**Required permissions**
The service user making the call must have the required permissions: see Permissions required.
**Pagination**
This endpoint uses cursor-based pagination to handle large number of table entries. To learn more, see Pagination in Bob's 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.
To successfully use this endpoint, a filter is mandatory. Ensure you use the filter provided in the **Example > Request example** option; otherwise, the call will fail.
**Required permissions**
The service user making the call must have the required permissions: see Permissions required.
**Pagination**
This endpoint uses cursor-based pagination to handle large number of table entries. To learn more, see Pagination in Bob's API
- [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 polling](https://apidocs.hibob.com/reference/get_company-reports-reportid-download-async) endpoint to obtain the report URL.
2. Copy only the name of the report (after the /download/) from the URL returned in the response header, and use it as the `reportName` for download.
For example: `https://app.hibob.com/v1/company/reports/download/2022-06-17T11_22_14.798810-test.JsonFormat`
3. If you receive 204 error response, this means the reports is not ready yet. In this case you should try again.
Permissions required:
The service user that you use for this call should have the required permissions. To learn more, see [Reports permissions](https://apidocs.hibob.com/reference/reports).
- [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 under a header called `Location`.
You can then obtain the report name and pass it to the next endpoint ([Download report file by URL](https://apidocs.hibob.com/reference/get_company-reports-download-reportname)):
1. Click **Headers** at the bottom of the response to see the URL.
2. Copy only the name of the report (after the /download/ part) and paste to the `reportName` for download.
Permissions required:
The service user that you use for this call should have the required permissions. To learn more, see [Reports permissions](https://apidocs.hibob.com/reference/reports).
- [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 have the required permissions. To learn more, see [Reports permissions](https://apidocs.hibob.com/reference/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.
Permissions required:
The service user that you use for this call should have the required permissions to access reports. To learn more, see [Reports permissions](https://apidocs.hibob.com/reference/reports).
- [Reports](https://apidocs.hibob.com/reference/reports.md): The Reports API provides access to the details of your company reports.
- [Start developing with the API](https://apidocs.hibob.com/reference/getting-started-with-bob-api.md): Get started with Bob's API reference guide
- [Read tasks of a specific employee ](https://apidocs.hibob.com/reference/get_tasks-people-id.md)
- [Read all open tasks.](https://apidocs.hibob.com/reference/get_tasks.md)
- [Tasks](https://apidocs.hibob.com/reference/tasks.md): The Tasks API provides access to the details of tasks.
- [Mark a task as complete](https://apidocs.hibob.com/reference/post_tasks-taskid-complete.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 Time off API Required Permissions page.
- [Time off balance](https://apidocs.hibob.com/reference/time-off-balance.md)
- [Create a balance adjustment.](https://apidocs.hibob.com/reference/post_timeoff-employees-id-adjustments.md): Create a balance adjustment for a given employee for a given effective date.
**Permissions required**: Please refer to the main Time off API Required Permissions page.
- [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 Time off API Required Permissions page.
- [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 Permissions page.
- [Get Policy type reason codes](https://apidocs.hibob.com/reference/get_timeoff-policy-types-policytype-reason-codes.md): Get list of reason codes for a given policy type.
**Permissions required**: Please refer to the main Time off API Required Permissions page.
- [Get Policy type details](https://apidocs.hibob.com/reference/get_timeoff-policy-types-policytype.md): Get details about a given policy type.
**Permissions required**: Please refer to the main Time off API Required Permissions page.
- [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 Permissions page.
- [Time off policies](https://apidocs.hibob.com/reference/time-off-policies.md)
- [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 Time off API Required Permissions page.
- [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 Permissions page.
- [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 request is for X hours during the requested day (supported only for policy types measured in hours).
- portionOnRange: the request is for every morning or every afternoon during the requested days.
- hoursOnRange: the request is for X hours every day during the requested days.
- differentDayDurations: the request is for a different amount of hours on each requested day.
- specificHoursDayDurations: the request is for specific hours per day.
- differentSpecificHoursDayDurations: the request is for different specific hours or portions on each day.
- percentageOnRange: the request is for X percent of every day during the requested days.
- openEnded: the request does not have an end date yet.
Each request type is represented by a separate schema with the relevant fields. Daily durations and cost:This endpoint returns a full daily duration and cost breakdown for all request types when includeDailyDurations=true is provided.
Permissions required: Please refer to the main Time off API Required Permissions page.
- [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 (requestRangeType): - days: the request is for X full days.
- hours: the request is for X hours during the requested day (supported only for policy types measured in hours).
- portionOnRange: the request is for every morning or every afternoon during the requested days.
- hoursOnRange: the request is for X hours every day during the requested days.
- differentDayDurations: the request is for a different number of hours on each requested day.
- specificHoursDayDurations: the request is for specific hours per day.
- differentSpecificHoursDayDurations: the request is for different specific hours or portions on each day.
- percentageOnRange: the request is for X percent of every day during the requested days.
- openEnded: the request does not have an end date yet.
Each request type is represented by a separate schema with the relevant fields. Durations and cost:
- This endpoint returns daily durations only for requests that use day-by-day duration configurations, including:
DifferentDayDurations, specificHoursDayDurations, differentSpecificHoursDayDurations. - These durations do not include a daily cost breakdown.
- All requests return
totalCost, which represents the amount deducted from the balance for the whole request. - To retrieve the cost per day, use Get the details of an existing time off request. with
includeDailyDurations=true.
Notes:
- Permissions: Follow the Time off API Required Permissions instructions to ensure the service user has the required permissions.
- Parameters: The data returned is also subject to parameters and the permissions granted to the Service User. Make sure you set the relevant permissions when using the 'includePending' flag.
- [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 change, such as `created` or `deleted`. Optionally, requests that were changed to status `pending` can also be included.
**Notes:**
- The results are filtered by **the date the change has occurred** (when the request was created or updated), not the start/end date of the time off request itself.
- Each change reflects a snapshot of the time off request's status **at the time of the change**, and may not reflect the current status.
Durations and cost:
- This endpoint returns daily durations only for requests that use day-by-day duration configurations, including:
DifferentDayDurations, specificHoursDayDurations, differentSpecificHoursDayDurations. - These durations do not include a daily cost breakdown.
- All requests return
totalCost, which represents the amount deducted from the balance for the whole request. - To retrieve the cost per day, use Get the details of an existing time off request. with
includeDailyDurations=true.
Permissions required: Please refer to the main Time off API Required Permissions page.
- [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 days.
- hours: the request is for X hours during the requested day (supported only for policy types measured in hours).
- portionOnRange: the request is for every morning or every afternoon during the requested days.
- hoursOnRange: the request is for X hours every day during the requested days.
- differentDayDurations: the request is for a different amount of hours on each requested day.
- specificHoursDayDurations: the request is for specific hours per day.
- differentSpecificHoursDayDurations: the request is for different specific hours or portions on each day.
- percentageOnRange: the request is for X percent of every day during the requested days.
- openEnded: the request does not have an end date yet.
Each request type is represented by a separate schema with the relevant fields. Durations and cost:
- This endpoint returns daily durations only for requests that use day-by-day duration configurations, including:
DifferentDayDurations, specificHoursDayDurations, differentSpecificHoursDayDurations. - These durations do not include a daily cost breakdown.
- All requests return
totalCost, which represents the amount deducted from the balance for the whole request. - To retrieve the cost per day, use Get the details of an existing time off request. with
includeDailyDurations=true.
Notes:
- Only active users are included in the response.
- Permissions: Follow the Time off API Required Permissions instructions to ensure the service user has the required permissions.
- Parameters: The data returned is subject to the parameters used and the permissions granted to the service user. Make sure the relevant permissions are set when using the
includePrivate and includePending flags.
- [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 params. Select the type in the body params section to view the expected fields.
**Testing Note:**
To test each type of request:
1. Open the relevant request type in the body params section.
2. In the test widget on the right, click "Request Example" to open the menu, and select the request type you want to send.
3. Update values and send.
**Important testing disclaimer:** Changing the request type example does not automatically switch the parameters. First, select the request schema, and then select the equivalent request in the "Request Example" to avoid inconsistencies in the example fields.
- [API calls for webhook v2 events](https://apidocs.hibob.com/reference/api-calls-for-webhook-events.md): API calls examples to retrieve the data relevant to webhook events
- [Docs events](https://apidocs.hibob.com/reference/docs-events-v2.md)
- [Employee events](https://apidocs.hibob.com/reference/employee-events-v2.md): The following events can be used to create Employee data updates 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.
- [Task events](https://apidocs.hibob.com/reference/task-events-v2.md): Receive notifications about triggered task lists and tasks status updates.
- [Time off events](https://apidocs.hibob.com/reference/time-off-events-v2.md): The following events can be used to create Time off request Webhooks.
- [Workforce planning events](https://apidocs.hibob.com/reference/workforce-planning-events.md): The following events can be used to create Workforce Planning webhooks.
- [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.
- [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)
- [[ Legacy] Webhooks v1](https://apidocs.hibob.com/reference/webhook-events-v1.md)
- [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.
- [Deletes Position Opening](https://apidocs.hibob.com/reference/delete_workforce-planning-positions-positionid-position-openings-positionopeningid.md): Deletes a position opening
- [Get all positions fields](https://apidocs.hibob.com/reference/get_metadata-objects-position.md): Returns a list of all fields of object type position.
- [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.
- [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.
- [Workforce Planning](https://apidocs.hibob.com/reference/workforce-planning.md): The Workforce Planning API provides access to positions in your company.
- [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., employees are still assigned to its openings).
To cancel filled positions, use the Schedule Positions Cancellation endpoint, which automatically unassigns employees before cancelling the position.
- [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
- [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 metadata endpoint to fetch list values.
- [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 can be used only with Job Catalog 2.0. To retrieve the `jobProfile`, use the Job Catalog API.
- For fields that require reference to a list in Bob (e.g. `department`), use the metadata endpoint to fetch list values.
- [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.
**Required permissions**
To access the positions, the service user making the call must have the following permissions:
**Features > Workforce planning > Position management > Manage positions**.
- [Read company positions budgets](https://apidocs.hibob.com/reference/post_positions-position-budget-search.md): This endpoint returns a list of company positions budgets filtered by the specified attributes. Note that this endpoint requires body parameters, which is why it is implemented as a POST request.
The required body parameters are:
- **Fields**: Specify the fields you want to retrieve. A list of available fields can be found in the 200 response body detailed below.
- **Filters**: Define the filtering conditions. You can filter by the fields defined in the filter section.
- **Pagination**: This endpoint uses cursor-based pagination to handle large number of table entries. To learn more, see Pagination in Bob's API
**Required permissions**
To access the positions, the service user making the call must have the following permissions:
**Features > Workforce planning > Position management > Manage positions**.
- [Read company positions openings](https://apidocs.hibob.com/reference/post_positions-position-openings-search.md): This endpoint returns a list of company positions openings filtered by the specified attributes. Note that this endpoint requires body parameters, which is why it is implemented as a POST request.
The required body parameters are:
- **Fields**: Specify the fields you want to retrieve. A list of available fields can be found in the 200 response body detailed below.
- **Filters**: Define the filtering conditions. You can filter by the fields defined in the filter section.
- **Pagination**: This endpoint uses cursor-based pagination to handle large number of table entries. To learn more, see Pagination in Bob's API
**Required permissions**
To access the positions, the service user making the call must have the following permissions:
**Features > Workforce planning > Position management > Manage positions**.
- [Create Position Budget](https://apidocs.hibob.com/reference/post_workforce-planning-positions-positionid-position-budget.md): Creates a specific position budget within a position **Limitations:**
- You can create up to 1 budget per request.
- If the request includes more than 1 budget, the operation will fail and return an error.
- [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, the operation will fail and return an error.
**Notes:**
- For fields that require reference to a list in Bob, use the metadata endpoint to fetch list values.
- [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:
- Cancellation date is optional. If provided, Positions are scheduled to be cancelled at 12:00 AM (midnight) on the specified date. Otherwise, they are cancelled immediately.
- If scheduled for a future date, the position and its openings will remain in status "Cancelled soon" until cancelled.
- After cancellation, the status will change to "Cancelled".
- If a position is `filled`, the employees assigned to the openings will be automatically unassigned before cancellation.
Limitations:
- Positions that are already canceled cannot be scheduled for cancellation again.
- [Create Position](https://apidocs.hibob.com/reference/post_workforce-planning-positions.md): Creates new positions with associated position opening and optional position budget.
**Limitations:**
- You can create up to 10 positions per request.
- If the request includes more than 10 positions, the operation will fail and return an error.
**Notes:**
- When creating a Position, the position opening is mandatory.
- Position budget is optional and will be created only if the service user has the required permission.
- The endpoint will return the ID of the positions and the position opening that were created. To find out the budget ID you should read the position details.
- Currently, you cannot create "position requests" that require an approval flow, which are not supported via the API.
- This endpoint requires linking the position to a job profile, and can be used only with Job Catalog 2.0. To retrieve the `jobProfile`, use the Job Catalog API.
- For fields that require reference to a list in Bob (e.g. `department`), use the metadata endpoint to fetch list values.
## Pages
- [API Changes & Deprecations](https://apidocs.hibob.com/api-changes-deprecations.md)
## Changelog
- [Time off API: cost field added to the daily breakdown](https://apidocs.hibob.com/changelog/time-off-api-cost-field-added-to-the-daily-breakdown.md)
- [Attendance API: Expanded project tasks API](https://apidocs.hibob.com/changelog/attendance-projects-api-expanded-project-tasks-api.md)
- [Attendance API: Attendance summaries and daily breakdown](https://apidocs.hibob.com/changelog/attendance-api-attendance-summaries-and-daily-breakdown-endpoints-added.md)
- [Hiring API: Job ad site and workspace type added](https://apidocs.hibob.com/changelog/hiring-api-accurate-job-ad-location-and-work-details.md)
- [Time off API: Added policy assignment status to balance](https://apidocs.hibob.com/changelog/time-off-api-added-assignment-status-to-balance.md)