Groups
- POSTCreate Group
- PUTEdit Group
- GETGet Group
- GETList Groups
- Configurations
- Connections
- Contacts
- Disconnections
- Enrollments
- Locations
- Plans
- Renewals
- Syncs
Members
- Employees
- Dependents
- Enrollments
- Premiums
Changes
- Snapshots
- Tracking
Legacy
- Requests
- Transactions
Get Dependent List
Returns a list of all dependents for a given employee.
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
The unique identifier of the employee for which you would like to view dependents
Query Parameters
The max size of each page of results
The integer offset at which to start the page. Possible values are 0 to total_records - 1
Response
Metadata associated with the response data
The offset of the first response record within the matching data set
x > 0The page number of the response records within the overall data set (1-based integer)
x > 1The maximum number of response records on each page of results
x > 1The total number of records in the entire matching data set
x > 0List of dependent results
The date the record was originated
Unique identifier of the employee in Noyo
Unique identifier of the dependent in Noyo
The date the record was last updated
Personal information for the dependent
ISO-8601 date string for the date of birth of the person
First name of the person
Home address of the person
City of the address
State postal code of the address
AL, AK, AZ, AR, CA, CO, CT, DE, DC, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY, AS, GU, MH, FM, MP, PW, PR, VI, UM Line one of the address
Zip code of the address
County of the address
Line two of the address
Last name of the person
Sex of the person
F, M, U, X Contact information for the person
Email address of the person
Type of email address
home, work Home phone number in E.164 format
Preferred written or spoken language of the person
Preferred method of contact for the person
mail, email, home-phone, work-phone, other True if the person can speak or communicate in English
Work phone number in E.164 format
Additional personal details of the person
American Indian status details (if applicable)
Primary state of the federally-recognized American Indian or Alaska Native tribe, if applicable
AL, AK, AZ, AR, CA, CO, CT, DE, DC, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY, AS, GU, MH, FM, MP, PW, PR, VI, UM Name of the federally-recognized American Indian or Alaska Native tribe, if applicable
Disability details (if applicable)
True if the person is in the military
True if the person is a student
Tobacco usage details (if applicable)
Duration of tobacco use
Frequency of tobacco use
List of types of tobacco use
pipe, cigarettes, chewing-tobacco True if the person uses tobacco of any kind
Maiden name of the person (deprecated)
Mailing address of the person, if different from home address
City of the address
State postal code of the address
AL, AK, AZ, AR, CA, CO, CT, DE, DC, FL, GA, HI, ID, IL, IN, IA, KS, KY, LA, ME, MD, MA, MI, MN, MS, MO, MT, NE, NV, NH, NJ, NM, NY, NC, ND, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VT, VA, WA, WV, WI, WY, AS, GU, MH, FM, MP, PW, PR, VI, UM Line one of the address
Zip code of the address
County of the address
Line two of the address
Marital status of the person
single, married, domestic-partner, divorced, widowed, legally-separated Middle name of the person
Social Security Number of the person
Suffix of the person
Relationship of the dependent to the employee
spouse, child, domestic-partner, grandchild, civil-union, step-child, foster-child, adopted-child, legal-guardianship, ex-spouse, other Version of the dependent record
The custom identifier for this dependent in your system
Was this page helpful?
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"
}
]
}