Return a list of employee homes.

get https://sandbox-api.kenjo.io/api/v1/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 Params

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.

Headers

Authorization

string

required

A valid bearer token.

Responses

401

UNAUTHORIZED. The Authorization header is incorrect, not provided or the token expired.

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://sandbox-api.kenjo.io/api/v1/employees/homes \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400BAD REQUEST. This is a wrong request in the client side due to invalid body or params.