Dependents
The
Dependent
object is used to represent a dependent (e.g. child, spouse, domestic partner, etc) of an Employee
Properties
id
UUIDRequired
remote_id
StringOptional
The third-party API ID of the matching object.
first_name
StringOptional
The dependents's first name.
middle_name
StringOptional
The dependents's middle name.
last_name
StringOptional
The dependents's last name.
relationship
EnumOptional
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.employee
UUIDOptional
The employee this person is a dependent of.
date_of_birth
DateTime (ISO 8601)Optional
The dependent's date of birth.
gender
EnumOptional
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_number
StringOptional
The dependent's phone number.
home_location
UUIDOptional
The dependents's home address.
is_student
BooleanOptional
Whether or not the dependent is a student
ssn
StringOptional
The dependents's social security number.
remote_was_deleted
BooleanRequired
Indicates whether or not this object has been deleted in the third party platform.
created_at
DateTime (ISO 8601)Required
modified_at
DateTime (ISO 8601)Required
This is the datetime that this object was last updated by Merge
field_mappings
ObjectOptional
remote_data
RemoteData[]Optional
GET
/dependents
https://api.merge.dev/api/hris/v1/dependents
US
EU
Returns a list of Dependent
objects.
Query & Path Parameters
created_after
DateTime (ISO 8601)Optional
If provided, will only return objects created after this datetime.
created_before
DateTime (ISO 8601)Optional
If provided, will only return objects created before this datetime.
cursor
StringOptional
The pagination cursor value.
include_deleted_data
BooleanOptional
Whether to include data that was marked as deleted by third party webhooks.
include_remote_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_sensitive_fields
BooleanOptional
Whether to include sensitive fields (such as social security numbers) in the response.
modified_after
DateTime (ISO 8601)Optional
If provided, only objects synced by Merge after this date time will be returned.
modified_before
DateTime (ISO 8601)Optional
If provided, only objects synced by Merge before this date time will be returned.
page_size
IntegerOptional
Number of results to return per page.
remote_id
StringOptional
The API provider's ID for the given object.
Field support by integration
See all supported fields
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_birth
DateTime (ISO 8601)employee
UUIDfirst_name
Stringgender
Enumhome_location
UUIDis_student
Booleanlast_name
Stringmiddle_name
Stringphone_number
Stringrelationship
Enumremote_data
RemoteData[]path
stringdata
stringremote_id
Stringssn
String
Ceridian 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_birth
DateTime (ISO 8601)employee
UUIDfirst_name
Stringgender
Enumis_student
Booleanlast_name
Stringrelationship
Enumremote_data
RemoteData[]path
stringdata
stringssn
String
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_birth
DateTime (ISO 8601)employee
UUIDfirst_name
Stringphone_number
Stringrelationship
Enumremote_data
RemoteData[]path
stringdata
stringremote_id
String
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_birth
DateTime (ISO 8601)employee
UUIDfirst_name
Stringlast_name
Stringrelationship
Enumremote_data
RemoteData[]path
stringdata
stringremote_id
StringGET
/dependents/{id}
https://api.merge.dev/api/hris/v1/dependents/{id}
US
EU
Returns a Dependent
object with the given id
.
Query & Path Parameters
id
UUIDRequired
include_remote_data
BooleanOptional
Whether to include the original data Merge fetched from the third-party to produce these models.
include_sensitive_fields
BooleanOptional
Whether to include sensitive fields (such as social security numbers) in the response.
Field support by integration
See all supported fields
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_birth
DateTime (ISO 8601)employee
UUIDfirst_name
Stringgender
Enumhome_location
UUIDis_student
Booleanlast_name
Stringmiddle_name
Stringphone_number
Stringrelationship
Enumremote_data
RemoteData[]path
stringdata
stringremote_id
Stringssn
String
Ceridian 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_birth
DateTime (ISO 8601)employee
UUIDfirst_name
Stringgender
Enumis_student
Booleanlast_name
Stringrelationship
Enumremote_data
RemoteData[]path
stringdata
stringssn
String
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_birth
DateTime (ISO 8601)employee
UUIDfirst_name
Stringphone_number
Stringrelationship
Enumremote_data
RemoteData[]path
stringdata
stringremote_id
String
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_birth
DateTime (ISO 8601)employee
UUIDfirst_name
Stringlast_name
Stringrelationship
Enumremote_data
RemoteData[]path
stringdata
stringremote_id
String