Dependents
The
Dependent object is used to represent a dependent (e.g. child, spouse, domestic partner, etc) of an EmployeeProperties
idUUIDRequired
remote_idStringOptional
The third-party API ID of the matching object.
created_atDateTime (ISO 8601)Required
The datetime that this object was created by Merge.
modified_atDateTime (ISO 8601)Required
The datetime that this object was modified by Merge.
first_nameStringOptional
The dependents's first name.
middle_nameStringOptional
The dependents's middle name.
last_nameStringOptional
The dependents's last name.
relationshipEnumOptional
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.employeeUUIDOptional
The employee this person is a dependent of.
date_of_birthDateTime (ISO 8601)Optional
The dependent's date of birth.
genderEnumOptional
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_numberStringOptional
The dependent's phone number.
home_locationUUIDOptional
The dependents's home address.
is_studentBooleanOptional
Whether or not the dependent is a student
ssnStringOptional
The dependents's social security number.
remote_was_deletedBooleanRequired
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_mappingsObjectOptional
remote_dataRemoteData[]Optional
GET
/dependents
Betahttps://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.
cursorStringOptional
The pagination cursor value.
include_deleted_dataBooleanOptional
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_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_sensitive_fieldsBooleanOptional
Whether to include sensitive fields (such as social security numbers) in the response.
include_shell_dataBooleanOptional
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_sizeIntegerOptional
Number of results to return per page.
remote_idStringOptional
The API provider's ID for the given object.
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
BambooHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
date_of_birthDateTime (ISO 8601)employeeUUIDfirst_nameStringgenderEnumhome_locationUUIDis_studentBooleanlast_nameStringmiddle_nameStringphone_numberStringrelationshipEnumremote_dataRemoteData[]pathstringdatastringremote_idStringssnString
Dayforce
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
date_of_birthDateTime (ISO 8601)employeeUUIDfirst_nameStringgenderEnumis_studentBooleanlast_nameStringrelationshipEnumremote_dataRemoteData[]pathstringdatastringssnString
HR Partner
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
date_of_birthDateTime (ISO 8601)employeeUUIDfirst_nameStringphone_numberStringrelationshipEnumremote_dataRemoteData[]pathstringdatastringremote_idString
UKG Ready
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
date_of_birthDateTime (ISO 8601)employeeUUIDfirst_nameStringlast_nameStringrelationshipEnumremote_dataRemoteData[]pathstringdatastringremote_idStringGET
/dependents/{id}
Betahttps://api.merge.dev/api/hris/v1/dependents/{id}
US
EU
APAC
Returns a Dependent object with the given id.
Query & Path Parameters
idUUIDRequired
include_remote_dataBooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_sensitive_fieldsBooleanOptional
Whether to include sensitive fields (such as social security numbers) in the response.
Field support by integration
See all supported fieldsUse the /linked-accounts endpoint to pull platform support information
BambooHR
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
date_of_birthDateTime (ISO 8601)employeeUUIDfirst_nameStringgenderEnumhome_locationUUIDis_studentBooleanlast_nameStringmiddle_nameStringphone_numberStringrelationshipEnumremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringDayforce
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
date_of_birthDateTime (ISO 8601)employeeUUIDfirst_nameStringgenderEnumis_studentBooleanlast_nameStringrelationshipEnumremote_dataRemoteData[]pathstringdatastringssnStringHR Partner
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
date_of_birthDateTime (ISO 8601)employeeUUIDfirst_nameStringphone_numberStringrelationshipEnumremote_dataRemoteData[]pathstringdatastringremote_idStringUKG Ready
On top of normalized Common Models, Merge also supports Passthrough Requests and deleted data detection for this platform's API
Supported Response Fields
date_of_birthDateTime (ISO 8601)employeeUUIDfirst_nameStringlast_nameStringrelationshipEnumremote_dataRemoteData[]pathstringdatastringremote_idString