Sign in

v1

latestOpenAPI 3.0.02026-07-14800227.2 KB
Employees

Return a list of employee homes.

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

get/employees/homes

Query parameters

maritalStatus'Divorced' | 'Domestic Partnership' | 'Married' | 'Separated' | 'Single' | 'Widowed'
Example:Widowed

The marital status. Only is valid one of the following values "Divorced", "Domestic Partnership", "Married", "Separated", "Single", "Widowed".

spouseFirstNamestring
Example:Catherine

The first name of the employee's spouse.

spouseLastNamestring
Example:Tramell

The last name of the employee's spouse.

spouseBirthdatestring
Example:2060-01-26T00:00:00.000Z

The birth date of the employee's spouse. Format YYYY-MM-DDThh:mm:ss.000Z.

spouseGender'Male' | 'Female' | 'Other'
Example:Female

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

personalEmailstring
Example:john.doe@acme.com

The employee personal email.

personalPhonestring
Example:4567092323

The employee personal phone.

personalMobilestring
Example:3567092310

The employee personal mobile.

Headers

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

A valid bearer token.

Response

OK

Example response

{
  "data": [
    {
      "_id": "80a2db290da29e126a187894",
      "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"
        },
        {
          "childFirstName": "Anna",
          "childLastName": "Kalevnikova",
          "childBirthdate": "2020-01-01T00:00:00.000Z",
          "childGender": "Female"
        }
      ]
    },
    {
      "_id": "80a2db290da29e126a187896",
      "maritalStatus": "Divorced",
      "spouseFirstName": "Beatrix",
      "spouseLastName": "Kido",
      "spouseBirthdate": "2067-04-20T00:00:00.000Z",
      "spouseGender": "Female",
      "personalEmail": "phillip@acme.io",
      "personalPhone": "8767092323",
      "personalMobile": "33267092310",
      "children": [
        {
          "childFirstName": "Pepe",
          "childLastName": "González",
          "childBirthdate": "2020-01-01T00:00:00.000Z",
          "childGender": "Male"
        }
      ]
    },
    {
      "_id": "80a2db290da29e126a187899",
      "maritalStatus": "Divorced",
      "spouseFirstName": "Ross",
      "spouseLastName": "Geller",
      "spouseBirthdate": "2068-12-06T00:00:00.000Z",
      "spouseGender": "Male",
      "personalEmail": "lina@acme.io",
      "personalPhone": "4167092323",
      "personalMobile": "78567092310"
    }
  ]
}