Get employee categories of a business

This endpoint returns all the employee categories defined at the business level.

GET /api/v2/businesses/{businessId}/person-categories

If the data provided in the request is correct —businessId—, the response will include the list of employee categories defined within the business, detailing the following information:

  • id: external identifier of the employee category.

  • name: name defined for the employee category.

Here is an example response:

[
    {
        "id": "RM",
        "name": "Restaurant Manager"
    },
    {
        "id": "CT",
        "name": "Crew Trainer"
    },
    {
        "name": "Manager Trainee"
    },
    {
        "id": "DR",
        "name": "Driver"
    }
]

The response will include the data defined for each category at the business level. As seen in the example, if the external identifier has not been set for a category in the system, that field will not be included in the response.

Considerations

If there are no categories for the business specified in the URL, the request will return an empty array [].

If a category does not have an external identifier defined in the system, the id field will not appear in the response.

The external identifier (id) is the reference field for API integrations and is strongly recommended to be configured in the system (Business configuration > Employee categories) to avoid managing duplicate categories.

Useful links

What are employee categories?

What is the difference between an employee category and an employee role?