Sign in

v1

latestOpenAPI 3.0.02026-07-14800227.2 KB
Employees

Return a list of employee personals.

This endpoint returns a list with the personal sections of the existing employees. Additionally, custom fields from this section will also be included.

get/employees/personals

Query parameters

firstNamestring
Example:John

The name of the Kenjo employee. This field is required.

lastNamestring
Example:Doe

The surname of the Kenjo employee. This field is required.

displayNamestring
Example:John Doe

The composition of firstName and lastName of the Kenjo employee.

gender'Male' | 'Female' | 'Other'
Example:es

The employee gender. Only is valid one of the following values 'Male' (male), 'Female' (female) or 'Other' (other).

birthdatestring
Example:1980-01-28T00:00:00.000Z

The employee birth date. Format YYYY-MM-DDThh:00:00.000Z.

nationalitystring
Example:Spanish

The employee nationality. The nationality must be the first letter in uppercase. Example "Spanish", "Brazilian"

Headers

Authorizationstring required
Example:Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJodHRwczovL2FwaS5rZW5qby5pbyIsInN1YiI6IjYwZjBhOTE2MjE0OTg3MjU2YmU5YzhmZiIsImF1ZCI6Imh0dHBzOi8vYXBpLmtlbmpvLmlvIiwiaWF0IjoxNjI2Mzg1MTE1LCJuYmYiOjE2MjYzODUxMTUsImV4cCI6MTYyNjU1NzkxNSwiYWNjZXNzVHlwZSI6IkFwaUFjY2VzcyIsInNfb3JnSWQiOiI2MGYwNGVhN2RmN2JhMjFlY2U0YmYzYzIifQ.cxG_7dIS-VbmDXdJuLkekoyuyCIzQG2fMcgc0nkfbWE8cihhcb5FnALbQkjU9b5-qVcEoMHZlSuUA-jMEBMMVQ

A valid bearer token.

Response

OK

Example response

{
  "data": [
    {
      "_id": "80a2db290da29e126a18789a",
      "firstName": "John",
      "lastName": "Doe",
      "displayName": "John Doe",
      "gender": "Male",
      "birthdate": "1989-03-09T00:00:00.000Z",
      "nationality": "Spanish"
    },
    {
      "_id": "80a2db290da29e126a18789a",
      "firstName": "Anna",
      "lastName": "Kalevnikova",
      "displayName": "Anna Kalevnikova",
      "gender": "Female",
      "birthdate": "1980-05-19T00:00:00.000Z",
      "nationality": "English"
    },
    {
      "_id": "80a2db290da29e126a18789a",
      "firstName": "Elvira",
      "lastName": "Dos Pasos",
      "displayName": "Elvira Dos Pasos",
      "gender": "Female",
      "birthdate": "1980-10-20T00:00:00.000Z",
      "nationality": "Vietnamese",
      "delegatedApproverId": "50a2db290da29e126a1878523"
    }
  ]
}