HIhibob
Metadata

Get all employee fields.

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. <br/><br/>However, fetching the actual data requires setting the relevant permissions for the service user, including permissions to access employee data and relevant categories. <br />To learn more, see <a href="https://apidocs.hibob.com/reference/post_people-search">Search for employees</a> .

get/company/people/fields

Request

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

Response

Successful response.

idstring

ID of the field.

categoryIdstring

ID of the field category.

categoryDisplayNamestring

Display name of the field category.

categorystring

To be deprecated. Use categoryId instead.

namestring

Name of the field.

descriptionstring

Description of the field.

jsonPathstring

A dot-separated path of this field value in the employee JSON returned by the /v1/profiles endpoint.

typestring

The type of the field. Supported field types: text, text-area, number, date, list, multi-list, hierarchy-list, currency, employee-reference, document.

historicalboolean

When true, this field keeps the history of its values, each being active starting from a certain date. The default value is false.

Changes

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