Read company employee fields by employee ID.

post

https://api.hibob.com/v1/people/{identifier}

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).

Path Params

identifier

string

required

The backend-id of the Employee. Retrieve this ID from the database.
For testing purposes, you can pull it from the URL in Bob when viewing the employee. For example, if the URL in Bob is "https://app.hibob.com/employee-profile/3332883884017713238" you should copy the "3332883884017713238".
Alternaticely you can provide the employee's email address.

Body Params

Read request content that allows you to select fields and other options

fields

array of strings

An optional list of fields to be returned in the response. When not specified, a default set of fields and categories are returned including:

Basic employee fields like: name, id, avatar URL, creation date, etc.

Basic categories:

About
Work

The complete fields schema is described in the 200 response status section.

fields

humanReadable

string

Defaults to .

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.

Flag values:

If not sent: will return only machine-format values. If you pass an invalid value it will be ignored and consdiered empty.

Possible values:

APPEND - include the additional "humanReadable" JSON node in the response.

REPLACE - supply only humanReadable values in the JSON response instead of machine-readable values.

Responses

400

Bad request. The request contains incorrect parameters or syntax errors. Please review the request body

403

Forbidden. The service user does not have permissions to access this table or employees. Check the permissions as explained in the endpoint description.

429

"Too Many Requests" error. This indicates that you've exceeded the rate limit for requests. Please verify that you are using the correct endpoint with the POST method. Additionally, check the HTTP headers for rate limit information, such as the number of requests allowed and the time until the limit resets. For more details, see Rate Limiting.

200Employee

defaultUnexpected error.