GET
/
api
/
v1
/
employees
/
{employee_id}
/
dependents
List All Dependents
curl --request GET \
  --url https://fulfillment.noyo.com/api/v1/employees/{employee_id}/dependents
{
  "meta": {
    "offset": 0,
    "page_num": 1,
    "page_size": 20,
    "total_records": 1
  },
  "response": [
    {
      "created": 1557512389,
      "employee_id": "30b74a44-d5b1-4123-a7a4-6d3aec251ba4",
      "id": "fd62665c-0846-4e9d-bd29-80779b5f685c",
      "modified": 1547412389,
      "person": {
        "contact": {
          "email_address": "diane@testemail.com",
          "email_address_type": "home",
          "home_phone": "+12065551234"
        },
        "date_of_birth": "1982-01-02",
        "first_name": "Diane",
        "home_address": {
          "city": "San Francisco",
          "county": "San Francisco",
          "state": "CA",
          "street_one": "1234 Home Ave",
          "zip_code": "94107"
        },
        "last_name": "Johnson",
        "marital_status": "",
        "sex": "F",
        "ssn": "987654321"
      },
      "relationship": "spouse",
      "version": "669fbe16-9960-4069-91aa-832ada3f4e42"
    }
  ]
}

Path Parameters

​
employee_id
string<uuid>
required

The unique identifier of the employee for which you would like to view dependents

Example:

"30b74a44-d5b1-4123-a7a4-6d3aec251ba4"

Query Parameters

​
page_size
integer

The max size of each page of results

​
offset
integer

The integer offset at which to start the page. Possible values are 0 to total_records - 1

Response

200 - application/json

Successful Response - Returns all matching Dependents

The response is of type object.