For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
Resources
Log inGet a demo
Get startedAPI referenceImplementation
Get startedAPI referenceImplementation
    • Overview
          • The Dependent object
          • GET/dependents
          • GET/dependents/{id}
UnifiedAgent HandlerGateway
UnifiedAgent HandlerGateway
Resources
Log inGet a demo
Common ModelsDependents

The Dependent object

The Dependent Object
1{
2  "id": "string",
3  "remote_id": "string",
4  "created_at": "2023-01-01T00:00:00Z",
5  "modified_at": "2023-01-01T00:00:00Z",
6  "first_name": "string",
7  "middle_name": "string",
8  "last_name": "string",
9  "relationship": "CHILD",
10  "employee": "string",
11  "date_of_birth": "2023-01-01T00:00:00Z",
12  "gender": "MALE",
13  "phone_number": "string",
14  "home_location": "string",
15  "is_student": true,
16  "ssn": "string",
17  "remote_was_deleted": true,
18  "field_mappings": {},
19  "remote_data": [
20    {
21      "path": "string",
22      "data": {}
23    }
24  ]
25}
Was this page helpful?
Previous

/companies/{id}

Next

/dependents

Built with

The Dependent object is used to represent a dependent (e.g. child, spouse, domestic partner, etc) of an Employee

idstringOptionalRead-onlyformat: "uuid"
remote_idstring or nullOptional
created_atdatetimeOptionalRead-only
The datetime that this object was created by Merge.
modified_atdatetimeOptionalRead-only
The datetime that this object was modified by Merge.
first_namestring or nullOptional<=60 characters
The dependents's first name.
middle_namestring or nullOptional<=60 characters
The dependents's middle name.
last_namestring or nullOptional<=60 characters
The dependents's last name.
relationshipenum or nullOptional
Allowed values:
employeestring or nullOptionalformat: "uuid"
The employee this person is a dependent of.
date_of_birthdatetime or nullOptional
The dependent's date of birth.
genderenum or nullOptional
Allowed values:
phone_numberstring or nullOptional<=50 characters
The dependent's phone number.
home_locationstring or nullOptionalformat: "uuid"
The dependents's home address.
is_studentboolean or nullOptional
Whether or not the dependent is a student
ssnstring or nullOptional<=50 characters
The dependents's social security number.
remote_was_deletedbooleanOptionalRead-only
field_mappingsobject or nullOptionalRead-only
remote_datalist of objects or nullOptionalRead-only