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

idUUID
Required

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

created_atDateTime (ISO 8601)
Required

modified_atDateTime (ISO 8601)
Required
This is the datetime that this object was last updated by Merge

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.

employeeUUID
Optional
The employee this person is a dependent of.

date_of_birthDateTime (ISO 8601)
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_locationUUID
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 in the third party platform.

field_mappingsObject
Optional

remote_dataRemoteData[]
Optional


GET
/dependents

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

US
EU

Returns a list of Dependent objects.


Query & Path Parameters

created_afterDateTime (ISO 8601)
Optional
If provided, will only return objects created after this datetime.

created_beforeDateTime (ISO 8601)
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_afterDateTime (ISO 8601)
Optional
If provided, only objects synced by Merge after this date time will be returned.

modified_beforeDateTime (ISO 8601)
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.

Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
BambooHR
BambooHR
Dayforce
Dayforce
HR Partner
HR Partner
UKG Ready
UKG Ready
GET
/dependents/{id}

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

US
EU

Returns a Dependent object with the given id.


Query & Path Parameters

idUUID
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.
Field support by integration
See all supported fields
Use the /linked-accounts endpoint to pull platform support information
BambooHR
BambooHR
Dayforce
Dayforce
HR Partner
HR Partner
UKG Ready
UKG Ready