Dependents
The Dependent object is used to represent a dependent (e.g. child, spouse, domestic partner, etc) of an Employee
Properties
idUUID
remote_idString
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)
The datetime that this object was modified by Merge.
first_nameString
The dependents's first name.
middle_nameString
The dependents's middle name.
last_nameString
The dependents's last name.
relationshipEnum
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. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.
employeeUUID
The employee this person is a dependent of.
date_of_birthDateTime (ISO 8601)
The dependent's date of birth.
genderEnum
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. To receive all enum values in the original format, use the show_enum_origins query parameter. Learn more.
phone_numberString
The dependent's phone number.
home_locationUUID
The dependents's home address.
is_studentBoolean
Whether or not the dependent is a student
ssnString
The dependents's social security number.
remote_was_deletedBoolean
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
field_mappingsObject
remote_dataRemoteData[]
The RemoteData object
The RemoteData object is used to represent the full data pulled from the third-party API for an object.
Properties
pathString
The third-party API path that is being called.
dataAny
The data returned from the third-party for this object in its original, unnormalized format.
GET
/dependents
Beta

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

US
EU
APAC

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
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.
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.
include_shell_dataBoolean
Optional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
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}
Beta

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

US
EU
APAC

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
Previous
Companies
Next Up
Employee Payroll Runs