Obtener 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.

Consideraciones

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 [].

Códigos de error

Este endpoint no devuelve códigos de error propios que no se encuentren descritos en errores comunes.

Enlaces de interés

¿Qué es un rol de empleado?