Obtener categorías de empleado de un negocio

Este endpoint devuelve todas las categorías de empleado definidas a nivel de negocio.

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

Si los datos incluidos en la petición son correctos —businessId—, la respuesta contendrá el listado de categorías de empleado definidas dentro del negocio, detallando la siguiente información:

  • id: identificador externo de la categoría de empleado.

  • name: nombre definido para la categoría de empleado.

A continuación, se muestra un ejemplo de respuesta:

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

La respuesta contendrá los datos que se hayan definido para cada categoría a nivel de negocio. Así, como se puede ver en el ejemplo, si no se ha establecido el identificador externo de la categoría en el sistema, la petición no podrá devolver ese dato.

Aspectos que tener en cuenta

Si no hay categorías para el negocio indicado en la URL, la petición devolverá un array vacío [].

Si alguna de las categorías no tiene definido el identificador externo en el sistema, en la respuesta no aparecerá este campo.

El identificador externo (id) es el campo de referencia para las integraciones por API y el que se recomienda encarecidamente establecer en el sistema (Configuración de negocio > Categorías de empleado) para evitar el manejo de categorías duplicadas.

Enlaces de interés

¿Qué son las categorías de empleado?

¿Cuál es la diferencia entre categoría de empleado y rol de empleado?