Sign in

v1

latestOpenAPI 3.1.1Proprietary2026-07-26184406877.9 KB
Employee Tables

Search for actual payments

This endpoint allows you to search for actual payments based on various filters.<br /> <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> <br><br> <b>Required permissions</b><br> For all the actual payments table entries: People's Data > Payroll > View selected employees' Payroll section histories. <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><br>Testing notes:<br/> 1. Use the testing widget's Try It! option to test this endpoint. <br> 2. Request Example: Use the Examples > Request example option to see how to initiate body parameters.<br /> 3. To test more than a single filter, copy the example to an external API testing app like Postman for better filtering options.<br> 4. Response Example: View the response payload using the Response > Response example option in the response on the right.

post/people/actual-payments/search

Request body

includeArchivedboolean

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

Example request

{
  "filters": [
    {
      "fieldPath": "employeeId",
      "operator": "equals",
      "values": [
        "100001"
      ]
    }
  ],
  "pagination": {
    "limit": 50
  }
}

Response

Search results for actual payments.

Example response

{
  "results": [
    {
      "employeeId": "10001",
      "id": 11111,
      "payType": "Bonus"
    }
  ]
}