Dependents
The
Dependent object is used to represent a dependent (e.g. child, spouse, domestic partner, etc) of an EmployeeProperties
idUUIDremote_idStringThe 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_nameStringThe dependents's first name.
middle_nameStringThe dependents's middle name.
last_nameStringThe dependents's last name.
relationshipEnumThe 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.employeeUUIDThe employee this person is a dependent of.
date_of_birthDateTime (ISO 8601)The dependent's date of birth.
genderEnumThe 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_numberStringThe dependent's phone number.
home_locationUUIDThe dependents's home address.
is_studentBooleanWhether or not the dependent is a student
ssnStringThe dependents's social security number.
remote_was_deletedBooleanIndicates 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_mappingsObjectremote_dataRemoteData[]The RemoteData object
The
RemoteData object is used to represent the full data pulled from the third-party API for an object.Properties
pathStringThe third-party API path that is being called.
dataAnyThe data returned from the third-party for this object in its original, unnormalized format.
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.
employee_idStringOptional
If provided, will only return dependents for this employee.
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. The maximum limit is 100.
remote_idStringOptional
The API provider's ID for the given object.
Field support by integration
Use 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_idString
Breathe
Gusto
Paychex
Proliant
GET
/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.
include_shell_dataBooleanOptional
Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).
Field support by integration
Use 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_idStringBreathe
Gusto
Paychex
Proliant