Sign in

v1

latestOpenAPI 3.1.1Proprietary2026-07-26184406877.9 KB
People

Search for employees

Search employee fields for many employees in one call. <p>See <b>Critical behaviors</b> below on this page for field IDs, filters, <code>showInactive</code>, permissions, no pagination, large-company batching, and integration limits. Full contract: <a href="https://apidocs.hibob.com/docs/people-read-api-contract" target="_blank">People read API contract</a>.</p> <p><b>Testing notes</b>:</p> <ol> <li>Use <b>Try It!</b> and <b>Examples > Request Example</b> (default: active employees only; other examples cover terminated employees and batched reads by ID).</li> <li>Explore the response payload using the <b>Example</b> in the Response panel.</li> </ol>

post/people/search

Request body

fieldsstring[]

Optional field IDs to return (max 400). Dot notation from <a href="https://apidocs.hibob.com/reference/get_company-people-fields" target="_blank">Fields metadata</a> (e.g. <code>root.id</code>). Omit for the default field set. See <b>Critical behaviors</b> below on this page.

showInactiveboolean

Include inactive (typically terminated/former) employees. Default <code>false</code> (active only). See <b>Critical behaviors</b> below on this page.

humanReadablestring

A flag that determines the data format to be returned in the response payload. Use this flag to convert "machine format" numeric IDs, such as "1644513820829" to the "human readable" values. <br /><br />Flag values:<br /> <br> <b>If not sent:</b> will return only machine-format values. If you pass an invalid value it will be ignored and consdiered empty.<br> <br> Possible values: <br> <br> <b>APPEND</b> - include the additional "humanReadable" JSON node in the response. <br> <br> <b>REPLACE</b> - supply only humanReadable values in the JSON response instead of machine-readable values. <br>

Example request

{
  "fields": [
    "root.id",
    "root.firstName"
  ],
  "filters": [
    {
      "fieldPath": "root.id",
      "operator": "equals",
      "values": [
        "<employee Id1>",
        "<employee Id2>"
      ]
    }
  ]
}

Response

Employees data response.

All 194 operations