Consultar roles de empleado disponibles

Este endpoint permite consultar los roles de empleado disponibles en un servicio.

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

Si los datos incluidos en la petición son correctos —businessId y serviceId—, la respuesta contendrá el listado de roles definidos a nivel de servicio.

Ejemplo de respuesta

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

  • id: identificador externo del rol de empleado. Solo se incluye si el rol tiene un identificador externo configurado en Orquest.

  • orquestId: identificador interno del rol de empleado en Orquest.

  • name: nombre del rol de empleado.

  • color: color del rol de empleado en formato hexadecimal.

Aspectos que tener en cuenta

Si no se ha definido el identificador externo del rol en el sistema, este campo no aparecerá en la respuesta.

Si no hay roles para el servicio, la petición devolverá un array vacío [].

Si el servicio no existe, la petición devolverá un error 404 Not Found indicando not exists.

Enlaces de interés

¿Qué es un rol de empleado?