Get employee roles

This endpoint allows querying the available employee roles in a service.

GET /api/v1/businesses/{businessId}/services/{serviceId}/employee-roles

If the provided data is correct —businessId and serviceId— the response will contain the list of roles defined at the service level. For example:

[
    {
        "orquestId": 13358,
        "name": "Commercial",
        "color": "#fad0e4"
    },
    {
        "id": "ID001",
        "orquestId": 19985,
        "name": "Manager",
        "color": "#921b01"
    }
]

The request returns the list of employee roles defined for the service as configured in Orquest. For example, if a role does not have an external identifier configured, the request will not be able to return that data.

Considerations

If there are no roles for the service, the request will return an empty array [].

If the service does not exist, the request will return a 404 Not Found error indicating not exists.

Useful links

What is an employee role?