get https://api.hibob.com/v1/company/people/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.
However, fetching the actual data requires setting the relevant permissions for the service user, including permissions to access employee data and relevant categories.
To learn more, see Search for employees .
Field category notes:
- The metadata of the field includes information about the category this field is stored in.
- The
categoyId: is the backend-id of the category, and it can be either text-based (for out-of-the-box categories), or numeric. It does not represent how the category appears in Bob's UI. - The
categoryDisplayName: is how the category appears in Bob's UI. Use this property to identify the category when setting permissions. To learn more, see Permissions
Endpoint URL: https://api.hibob.com/v1/company/people/fields