Dependents
The Dependent object is used to represent a dependent (e.g. child, spouse, domestic partner, etc) of an EmployeeProperties
idStringRequired
remote_idStringOptional
The third-party API ID of the matching object.
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.employeeStringOptional
The employee this person is a dependent of.
date_of_birthStringOptional
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.phone_numberStringOptional
The dependent's phone number.
home_locationStringOptional
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 by third party webhooks.
created_atStringRequired
modified_atStringRequired
This is the datetime that this object was last updated by Merge
field_mappingsObjectOptional
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
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
created_afterStringOptional
If provided, will only return objects created after this datetime.
created_beforeStringOptional
If provided, will only return objects created before this datetime.
cursorStringOptional
The pagination cursor value.
include_deleted_dataBooleanOptional
Whether to include data that was marked as deleted by third party webhooks.
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.
modified_afterStringOptional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforeStringOptional
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.
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
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
date_of_birthStringemployeeStringfirst_nameStringgenderEnumhome_locationStringis_studentBooleanlast_nameStringmiddle_nameStringphone_numberStringrelationshipEnumremote_dataRemoteData[]pathstringdatastringremote_idStringssnString
Ceridian Dayforce
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
date_of_birthStringemployeeStringfirst_nameStringgenderEnumis_studentBooleanlast_nameStringrelationshipEnumremote_dataRemoteData[]pathstringdatastringssnString
HR Partner
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
date_of_birthStringemployeeStringfirst_nameStringphone_numberStringrelationshipEnumremote_dataRemoteData[]pathstringdatastringremote_idString
UKG Ready
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
date_of_birthStringemployeeStringfirst_nameStringlast_nameStringrelationshipEnumremote_dataRemoteData[]pathstringdatastringremote_idStringHint: 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
AuthorizationStringRequired
Token-based authentication with required prefix "Bearer"
X-Account-TokenStringRequired
Token identifying the end user.
Query & Path Parameters
idStringRequired
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.
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
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
date_of_birthStringemployeeStringfirst_nameStringgenderEnumhome_locationStringis_studentBooleanlast_nameStringmiddle_nameStringphone_numberStringrelationshipEnumremote_dataRemoteData[]pathstringdatastringremote_idStringssnStringCeridian Dayforce
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
date_of_birthStringemployeeStringfirst_nameStringgenderEnumis_studentBooleanlast_nameStringrelationshipEnumremote_dataRemoteData[]pathstringdatastringssnStringHR Partner
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
date_of_birthStringemployeeStringfirst_nameStringphone_numberStringrelationshipEnumremote_dataRemoteData[]pathstringdatastringremote_idStringUKG Ready
Merge supports Passthrough Requests to this platform's API
Supported Response Fields
date_of_birthStringemployeeStringfirst_nameStringlast_nameStringrelationshipEnumremote_dataRemoteData[]pathstringdatastringremote_idStringHint: Use the /linked-accounts endpoint to pull platform support information.