HIhibob
Employee Tables

List payroll history (salaries) for a list of employees.

Returns a list of historical salary entries from the payroll table for all employees or a specific list of employees.<br /> <br /> <b>Required permissions</b> <br /> In order to access the payroll history of each requested employee, the service user making the call must have the following permissions: <br /> For all the salary table entries: People's Data > People's fields > Salary (Table) > View history, and View on the table or required columns. <br /> For the current effective salary entry only: People's Data > People's fields > Salary (Table) > View. <br /> 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. <br />

<b>Pagination</b> <br /> This endpoint uses cursor-based pagination to handle large number of table entries. To learn more, see <a href="https://apidocs.hibob.com/docs/pagination" target=”_blank”>Pagination in Bob's API</a>

get/bulk/people/salaries

Request

  • Base URL
    https://api.hibob.com/v1
  • URL
    https://api.hibob.com/v1/bulk/people/salaries
  • Auth
    • HTTP basic
    • or HTTP bearer

Query parameters

limitnumber

Specifies the number of table entries to include on each page of the results.

cursorstring

A marker representing the first item on the next page to read. Make sure to URL encode this value before you send it as a query parameter. To learn more, see <a href="https://apidocs.hibob.com/docs/pagination" target=”_blank”>Pagination in Bob's API</a>.

employeeIdsstring

Comma separated list of employee ids. Maximum employees per request: 200. If this parameter is not passed, the API will return history records for all the employees for which the service user has the permission for.

includeArchivedboolean

By default (false), archived columns are excluded from the response. When set to true, archived columns are included.

Response

Payroll (salaries) table entries.

Example response

{
  "errors": [
    {
      "employeeId": {
        "error": "MISSING_PERMISSION",
        "message": "You don't have permission to access data for employees with ids: 2578509511618723822"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.