Obtener información de un empleado

Este endpoint devuelve la información de un empleado filtrado a través de su identificador (employeeId).

GET /api/v2/businesses/{businessId}/employees/{employeeId}

Si los datos incluidos en la petición son correctos —tanto el businessId como el employeeId—, la respuesta contendrá la información definida para el empleado:

  • Ejemplo 1

  • Ejemplo 2

{
    "name": "Mariane",
    "surname": "Ortega Acevedo",
    "birthday": "2004-01-02",
    "employeeId": "1006350",
    "virtual": false
}
{
      "name": "Brian",
      "surname": "Cohen",
      "group": "01",
      "email": "brian@orquest.com",
      "birthday": "1987-12-01",
      "employeeId": "021298521",
      "metadata": {
        "language": "english",
        "nationality": "scottish"
      },
      "seniority": "2021-12-01",
      "aptitudes": [
        {
          "productId": "C14",
          "aptitudes": [
            {
              "locationId": "101",
              "level": 3
            },
            {
              "locationId": "102",
              "level": 2
            }
          ]
        }
      ],
      "virtual": false
}

Tal y como se aprecia en los ejemplos, la petición devolverá la información definida para el empleado. Así, aquellos campos no obligatorios, cuya información no haya sido definida en Orquest, no aparecerán en la respuesta. Del mismo modo, los metadatos solo aparecerán en los negocios que hayan configurado previamente esta información para sus empleados.

Aspectos que tener en cuenta

Si el identificador de empleado indicado en la URL no existe en el negocio, la petición devolverá un error 404 Not Found, especificando en el mensaje Employee not found.

Enlaces de interés

¿Qué es un empleado?

¿Qué es una asociación a servicio?

¿Qué es un contrato? ¿Y un tipo de contrato?

¿Cómo integrar empleados?