Get employee information
This endpoint retrieves the information of an employee filtered by their identifier (employeeId).
GET /api/v2/businesses/{businessId}/employees/{employeeId}If the data included in the request is correct —both businessId and employeeId—, the response will contain the information defined for the employee:
{
"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
}As shown in the examples, the request will return the defined information for the identified employee. Thus, those non-mandatory fields whose information has not been defined in Orquest will not appear in the response. In the same way, metadata will only appear in businesses that have previously configured this information for their employees.
Considerations
If the employee ID specified in the URL does not exist in the business, the request will return a 404 Not Found error, specifying Employee not found in the message.