v1

latestOpenAPI 3.0.02026-07-14800227.2 KB
Employees

Return all the sections information for a given employee Id.

This endpoint returns information about the account, personal, work, work schedule, address, financial and home sections for a given employee id. The employeeId param represents a Kenjo employee id. Additionally, custom fields configured for the respective sections will also be returned. The confidential section (employee exit data — terminationDate, terminationReasonId, terminationReasonName) is only returned when the API key has the Confidential permission enabled; it is omitted (not an error) otherwise.

get/employees/{employeeId}

Path parameters

employeeIdstring required
Example:50a2db290da29e126a187843

The _id of the employee to request.

Headers

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

A valid bearer token.

Response

OK

Example response

{
  "account": {
    "_id": "50a2db290da29e126a187843",
    "email": "john@acme.io",
    "externalId": "E-000001",
    "isActive": true,
    "language": "es"
  },
  "personal": {
    "firstName": "John",
    "lastName": "Doe",
    "displayName": "John Doe",
    "gender": "Male",
    "birthdate": "1980-01-28T00:00:00.000Z",
    "nationality": "Spanish",
    "delegatedApproverId": "50a2db290da29e126a1878523"
  },
  "work": {
    "companyId": "50a2db290da29e126a187894",
    "officeId": "50a2db290da29e126a187895",
    "departmentId": "50a2db290da29e126a187896",
    "areaIds": [
      "68370faa00aab31dedd4c35f",
      "68370f9400aab31dedd4c358"
    ],
    "teamIds": [
      "68370faa00aab31dedd4c35f",
      "68370f9400aab31dedd4c358"
    ],
    "startDate": "2021-07-01T00:00:00.000Z",
    "jobTitle": "Actor",
    "workPhone": "+34 666 70 90 32",
    "workMobile": "+34 680 70 90 32",
    "probationPeriodEnd": "2022-06-01T00:00:00.000Z",
    "timeOffApproverId": "50a2db290da29e126a1878523",
    "contractEnd": "2030-06-01T00:00:00.000Z",
    "reportsToId": "50a2db290da29e126a1878523"
  },
  "workSchedule": {
    "mondayWorkingDay": true,
    "tuesdayWorkingDay": true,
    "wednesdayWorkingDay": true,
    "thursdayWorkingDay": true,
    "fridayWorkingDay": true,
    "saturdayWorkingDay": true,
    "sundayWorkingDay": true,
    "overtimeSettings": {
      "waiverActive": true,
      "waiverType": "monthly",
      "waiver": 60
    }
  },
  "address": {
    "street": "Calle Enrique San Francisco 13",
    "postalCode": "28080",
    "city": "Madrid",
    "country": "ES",
    "houseNumber": "1-F",
    "additionalAddress": "Calle Henry Francisco 14"
  },
  "financial": {
    "accountHolderName": "Michael Corleone",
    "bankName": "Bank of Sicily",
    "accountNumber": "0093 344 2132221 3304 00",
    "iban": "DE32120222391919191911",
    "swiftCode": "12321234",
    "nationalId": "04123547X",
    "passport": "FA1234098",
    "nationalInsuranceNumber": "23123312321",
    "taxCode": "323451R",
    "taxIdentificationNumber": "T4312345"
  },
  "home": {
    "maritalStatus": "Widowed",
    "spouseFirstName": "Catherine",
    "spouseLastName": "Tramell",
    "spouseBirthdate": "2060-01-26T00:00:00.000Z",
    "spouseGender": "Female",
    "personalEmail": "john@acme.io",
    "personalPhone": "4567092323",
    "personalMobile": "3567092310",
    "children": [
      {
        "childFirstName": "John",
        "childLastName": "Doe",
        "childBirthdate": "2020-01-01T00:00:00.000Z",
        "childGender": "Male"
      }
    ]
  },
  "emergency": {
    "emergencyFirstName": "John",
    "emergencyMiddleName": "Doe",
    "emergencyLastName": "Doe",
    "relation": "Mother",
    "emergencyPhoneNumber": "+34 666 70 90 32",
    "emergencyMobileNumber": "+34 680 70 90 32"
  },
  "confidential": {
    "terminationDate": "2025-12-31T00:00:00.000Z",
    "terminationReasonId": "50a2db290da29e126a187901",
    "terminationReasonName": "Termination by Mutual Agreement"
  }
}