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

idString
Required

remote_idString
Optional
The third-party API ID of the matching object.

first_nameString
Optional
The dependents's first name.

middle_nameString
Optional
The dependents's middle name.

last_nameString
Optional
The dependents's last name.

relationshipEnum
Optional
The dependent's relationship to the employee. Possible values include: CHILD, SPOUSE, DOMESTIC_PARTNER. In cases where there is no clear mapping, the original value passed through will be returned.

employeeString
Optional
The employee this person is a dependent of.

date_of_birthString
Optional
The dependent's date of birth.

genderEnum
Optional
The dependent's gender. Possible values include: MALE, FEMALE, NON-BINARY, OTHER, PREFER_NOT_TO_DISCLOSE. In cases where there is no clear mapping, the original value passed through will be returned.

phone_numberString
Optional
The dependent's phone number.

home_locationString
Optional
The dependents's home address.

is_studentBoolean
Optional
Whether or not the dependent is a student

ssnString
Optional
The dependents's social security number.

remote_was_deletedBoolean
Required
Indicates whether or not this object has been deleted by third party webhooks.

created_atString
Required

modified_atString
Required
This is the datetime that this object was last updated by Merge

field_mappingsObject
Optional

remote_dataRemoteData[]
Optional

The Dependent object
JSON
{
"id": "025fjlc6-6000-430a-848e-aafacbadf4fe",
"remote_id": "19202940",
"first_name": "Greg",
"middle_name": "A",
"last_name": "Hirsch",
"relationship": "CHILD",
"employee": "0958cbc6-6040-430a-848e-aafacbadf4ae",
"date_of_birth": "1990-11-10T00:00:00Z",
"gender": "MALE",
"phone_number": "+1234567890",
"home_location": "d2f972d0-2526-434b-9409-4c3b468e08f0",
"is_student": true,
"ssn": "1234567890",
"remote_was_deleted": true,
"created_at": "2021-09-15T00:00:00Z",
"modified_at": "2021-10-16T00:00:00Z",
Show advanced fields
}

GET
/dependents

https://api.merge.dev/api/hris/v1/dependents

US
EU

Returns a list of Dependent objects.


Header Parameters

AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.
Query & Path Parameters

created_afterString
Optional
If provided, will only return objects created after this datetime.

created_beforeString
Optional
If provided, will only return objects created before this datetime.

cursorString
Optional
The pagination cursor value.

include_deleted_dataBoolean
Optional
Whether to include data that was marked as deleted by third party webhooks.

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

include_sensitive_fieldsBoolean
Optional
Whether to include sensitive fields (such as social security numbers) in the response.

modified_afterString
Optional
If provided, only objects synced by Merge after this date time will be returned.

modified_beforeString
Optional
If provided, only objects synced by Merge before this date time will be returned.

page_sizeInteger
Optional
Number of results to return per page.

remote_idString
Optional
The API provider's ID for the given object.

Response
JSON
{
"next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
"previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
"results": [
{
"id": "025fjlc6-6000-430a-848e-aafacbadf4fe",
"remote_id": "19202940",
"first_name": "Greg",
"middle_name": "A",
"last_name": "Hirsch",
"relationship": "CHILD",
"employee": "0958cbc6-6040-430a-848e-aafacbadf4ae",
"date_of_birth": "1990-11-10T00:00:00Z",
"gender": "MALE",
"phone_number": "+1234567890",
"home_location": "d2f972d0-2526-434b-9409-4c3b468e08f0",
"is_student": true,
"ssn": "1234567890",
"remote_was_deleted": true,
"created_at": "2021-09-15T00:00:00Z",
"modified_at": "2021-10-16T00:00:00Z",
Show advanced fields
}
]
}
Field support by platform
BambooHR
BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


date_of_birthString

employeeString

first_nameString

genderEnum

home_locationString

is_studentBoolean

last_nameString

middle_nameString

phone_numberString

relationshipEnum

remote_dataRemoteData[]
pathstring
datastring

remote_idString

ssnString
Ceridian Dayforce
Ceridian Dayforce

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


date_of_birthString

employeeString

first_nameString

genderEnum

is_studentBoolean

last_nameString

relationshipEnum

remote_dataRemoteData[]
pathstring
datastring

ssnString
HR Partner
HR Partner

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


date_of_birthString

employeeString

first_nameString

phone_numberString

relationshipEnum

remote_dataRemoteData[]
pathstring
datastring

remote_idString
UKG Ready
UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


date_of_birthString

employeeString

first_nameString

last_nameString

relationshipEnum

remote_dataRemoteData[]
pathstring
datastring

remote_idString
Hint: Use the /linked-accounts endpoint to pull platform support information.
GET
/dependents/{id}

https://api.merge.dev/api/hris/v1/dependents/{id}

US
EU

Returns a Dependent object with the given id.


Header Parameters

AuthorizationString
Required
Token-based authentication with required prefix "Bearer"

X-Account-TokenString
Required
Token identifying the end user.
Query & Path Parameters

idString
Required

include_remote_dataBoolean
Optional
Whether to include the original data Merge fetched from the third-party to produce these models.

include_sensitive_fieldsBoolean
Optional
Whether to include sensitive fields (such as social security numbers) in the response.
Response
JSON
{
"id": "025fjlc6-6000-430a-848e-aafacbadf4fe",
"remote_id": "19202940",
"first_name": "Greg",
"middle_name": "A",
"last_name": "Hirsch",
"relationship": "CHILD",
"employee": "0958cbc6-6040-430a-848e-aafacbadf4ae",
"date_of_birth": "1990-11-10T00:00:00Z",
"gender": "MALE",
"phone_number": "+1234567890",
"home_location": "d2f972d0-2526-434b-9409-4c3b468e08f0",
"is_student": true,
"ssn": "1234567890",
"remote_was_deleted": true,
"created_at": "2021-09-15T00:00:00Z",
"modified_at": "2021-10-16T00:00:00Z",
Show advanced fields
}
Field support by platform
BambooHR
BambooHR

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


date_of_birthString

employeeString

first_nameString

genderEnum

home_locationString

is_studentBoolean

last_nameString

middle_nameString

phone_numberString

relationshipEnum

remote_dataRemoteData[]
pathstring
datastring

remote_idString

ssnString
Ceridian Dayforce
Ceridian Dayforce

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


date_of_birthString

employeeString

first_nameString

genderEnum

is_studentBoolean

last_nameString

relationshipEnum

remote_dataRemoteData[]
pathstring
datastring

ssnString
HR Partner
HR Partner

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


date_of_birthString

employeeString

first_nameString

phone_numberString

relationshipEnum

remote_dataRemoteData[]
pathstring
datastring

remote_idString
UKG Ready
UKG Ready

Merge supports Passthrough Requests to this platform's API

Supported Response Fields


date_of_birthString

employeeString

first_nameString

last_nameString

relationshipEnum

remote_dataRemoteData[]
pathstring
datastring

remote_idString
Hint: Use the /linked-accounts endpoint to pull platform support information.