---
title: "Return a list of employee homes."
method: GET
path: "/employees/homes"
tags: ["Employees"]
---

# Return a list of employee homes.

`GET /employees/homes`

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

## Query parameters

- `maritalStatus` 'Divorced' | 'Domestic Partnership' | 'Married' | 'Separated' | 'Single' | 'Widowed'
- `spouseFirstName` string
- `spouseLastName` string
- `spouseBirthdate` string
- `spouseGender` 'Male' | 'Female' | 'Other'
- `personalEmail` string
- `personalPhone` string
- `personalMobile` string

## Headers

- `Authorization` string, required

## Response `200`

OK

- object
  - `data` object[]
    - `_id` string — The _id of the Kenjo employee.
    - `maritalStatus` string — The marital status. Only is valid one of the following values "Divorced", "Domestic Partnership", "Married", "Separated", "Single", "Widowed".
    - `spouseFirstName` string — The first name of the employee's spouse.
    - `spouseLastName` string — The last name of the employee's spouse.
    - `spouseBirthdate` string — The birth date of the employee's spouse. Format YYYY-MM-DDThh:mm:ss.000Z.
    - `spouseGender` string — The employee's spouse gender. Only is valid one of the following values 'Male' (male), 'Female' (female) or 'Other' (other).
    - `personalEmail` string — The employee personal email.
    - `personalPhone` string — The employee personal phone.
    - `personalMobile` string — The employee personal mobile.
    - `children` unknown[] — The employee children.
      - unknown

## Other responses

- `400` — BAD REQUEST. This is a wrong request in the client side due to invalid body or params.
- `401` — UNAUTHORIZED. The Authorization header is incorrect, not provided or the token expired.

---

[API](https://skmtc.net/kenjo/apis/kenjo-api.md) · [All operations](https://skmtc.net/kenjo/apis/kenjo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kenjo/kenjo-api/versions/58772b78268e/schema)
