/dependents

import { MergeClient } from "@mergeapi/merge-node-client";
const client = new MergeClient({ apiKey: "YOUR_API_KEY", accountToken: "YOUR_ACCOUNT_TOKEN" });
const pageableResponse = await client.hris.dependents.list({
    createdAfter: new Date("2024-01-15T09:30:00.000Z"),
    createdBefore: new Date("2024-01-15T09:30:00.000Z"),
    cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
    employeeId: "employee_id",
    includeDeletedData: true,
    includeRemoteData: true,
    includeSensitiveFields: true,
    includeShellData: true,
    modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
    modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
    pageSize: 1,
    remoteId: "remote_id"
});
for await (const item of pageableResponse) {
    console.log(item);
}
// Or you can manually iterate page-by-page
let page = await client.hris.dependents.list({
    createdAfter: new Date("2024-01-15T09:30:00.000Z"),
    createdBefore: new Date("2024-01-15T09:30:00.000Z"),
    cursor: "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
    employeeId: "employee_id",
    includeDeletedData: true,
    includeRemoteData: true,
    includeSensitiveFields: true,
    includeShellData: true,
    modifiedAfter: new Date("2024-01-15T09:30:00.000Z"),
    modifiedBefore: new Date("2024-01-15T09:30:00.000Z"),
    pageSize: 1,
    remoteId: "remote_id"
});
while (page.hasNextPage()) {
    page = page.getNextPage();
}
// You can also access the underlying response
const response = page.response;

{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "id": "025fjlc6-6000-430a-848e-aafacbadf4fe",
      "remote_id": "19202940",
      "created_at": "2021-09-15T00:00:00Z",
      "modified_at": "2021-10-16T00:00:00Z",
      "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,
      "field_mappings": {
        "organization_defined_targets": {
          "custom_key": "custom_value"
        },
        "linked_account_defined_targets": {
          "custom_key": "custom_value"
        }
      },
      "remote_data": [
        {
          "path": "/dependent"
        }
      ]
    }
  ]
}

Returns a list of Dependent objects.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Query parameters

created_afterdatetimeOptional

If provided, will only return objects created after this datetime.

created_beforedatetimeOptional

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_afterdatetimeOptional

If provided, only objects synced by Merge after this date time will be returned.

modified_beforedatetimeOptional

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.

Response

nextstring or null

previousstring or null

resultslist of objects or null

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional<=60 characters

The dependents's first name.

middle_namestring or nullOptional<=60 characters

The dependents's middle name.

last_namestring or nullOptional<=60 characters

The dependents's last name.

relationshipenum or nullOptional

The dependent’s relationship to the employee.

CHILD - CHILD
SPOUSE - SPOUSE
DOMESTIC_PARTNER - DOMESTIC_PARTNER

Allowed values:

employeestring or nullOptionalformat: "uuid"

The employee this person is a dependent of.

date_of_birthdatetime or nullOptional

The dependent's date of birth.

genderenum or nullOptional

The dependent’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

phone_numberstring or nullOptional<=50 characters

The dependent's phone number.

home_locationstring or nullOptionalformat: "uuid"

The dependents's home address.

is_studentboolean or nullOptional

Whether or not the dependent is a student

ssnstring or nullOptional<=50 characters

The dependents's social security number.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

first_namestring or nullOptional<=60 characters

The dependents's first name.

last_namestring or nullOptional<=60 characters

The dependents's last name.

relationshipenum or nullOptional

The dependent’s relationship to the employee.

CHILD - CHILD
SPOUSE - SPOUSE
DOMESTIC_PARTNER - DOMESTIC_PARTNER

Allowed values:

employeestring or nullOptionalformat: "uuid"

The employee this person is a dependent of.

date_of_birthdatetime or nullOptional

The dependent's date of birth.

genderenum or nullOptional

The dependent’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

is_studentboolean or nullOptional

Whether or not the dependent is a student

ssnstring or nullOptional<=50 characters

The dependents's social security number.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional<=60 characters

The dependents's first name.

relationshipenum or nullOptional

The dependent’s relationship to the employee.

CHILD - CHILD
SPOUSE - SPOUSE
DOMESTIC_PARTNER - DOMESTIC_PARTNER

Allowed values:

employeestring or nullOptionalformat: "uuid"

The employee this person is a dependent of.

date_of_birthdatetime or nullOptional

The dependent's date of birth.

phone_numberstring or nullOptional<=50 characters

The dependent's phone number.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional<=60 characters

The dependents's first name.

last_namestring or nullOptional<=60 characters

The dependents's last name.

relationshipenum or nullOptional

The dependent’s relationship to the employee.

CHILD - CHILD
SPOUSE - SPOUSE
DOMESTIC_PARTNER - DOMESTIC_PARTNER

Allowed values:

employeestring or nullOptionalformat: "uuid"

The employee this person is a dependent of.

date_of_birthdatetime or nullOptional

The dependent's date of birth.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional<=60 characters

The dependents's first name.

middle_namestring or nullOptional<=60 characters

The dependents's middle name.

last_namestring or nullOptional<=60 characters

The dependents's last name.

relationshipenum or nullOptional

The dependent’s relationship to the employee.

CHILD - CHILD
SPOUSE - SPOUSE
DOMESTIC_PARTNER - DOMESTIC_PARTNER

Allowed values:

employeestring or nullOptionalformat: "uuid"

The employee this person is a dependent of.

date_of_birthdatetime or nullOptional

The dependent's date of birth.

genderenum or nullOptional

The dependent’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

phone_numberstring or nullOptional<=50 characters

The dependent's phone number.

home_locationstring or nullOptionalformat: "uuid"

The dependents's home address.

is_studentboolean or nullOptional

Whether or not the dependent is a student

ssnstring or nullOptional<=50 characters

The dependents's social security number.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional<=60 characters

The dependents's first name.

middle_namestring or nullOptional<=60 characters

The dependents's middle name.

last_namestring or nullOptional<=60 characters

The dependents's last name.

relationshipenum or nullOptional

The dependent’s relationship to the employee.

CHILD - CHILD
SPOUSE - SPOUSE
DOMESTIC_PARTNER - DOMESTIC_PARTNER

Allowed values:

employeestring or nullOptionalformat: "uuid"

The employee this person is a dependent of.

date_of_birthdatetime or nullOptional

The dependent's date of birth.

genderenum or nullOptional

The dependent’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

phone_numberstring or nullOptional<=50 characters

The dependent's phone number.

home_locationstring or nullOptionalformat: "uuid"

The dependents's home address.

is_studentboolean or nullOptional

Whether or not the dependent is a student

ssnstring or nullOptional<=50 characters

The dependents's social security number.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

first_namestring or nullOptional<=60 characters

The dependents's first name.

last_namestring or nullOptional<=60 characters

The dependents's last name.

relationshipenum or nullOptional

The dependent’s relationship to the employee.

CHILD - CHILD
SPOUSE - SPOUSE
DOMESTIC_PARTNER - DOMESTIC_PARTNER

Allowed values:

employeestring or nullOptionalformat: "uuid"

The employee this person is a dependent of.

date_of_birthdatetime or nullOptional

The dependent's date of birth.

genderenum or nullOptional

The dependent’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

is_studentboolean or nullOptional

Whether or not the dependent is a student

ssnstring or nullOptional<=50 characters

The dependents's social security number.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional<=60 characters

The dependents's first name.

relationshipenum or nullOptional

The dependent’s relationship to the employee.

CHILD - CHILD
SPOUSE - SPOUSE
DOMESTIC_PARTNER - DOMESTIC_PARTNER

Allowed values:

employeestring or nullOptionalformat: "uuid"

The employee this person is a dependent of.

date_of_birthdatetime or nullOptional

The dependent's date of birth.

phone_numberstring or nullOptional<=50 characters

The dependent's phone number.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional<=60 characters

The dependents's first name.

last_namestring or nullOptional<=60 characters

The dependents's last name.

relationshipenum or nullOptional

The dependent’s relationship to the employee.

CHILD - CHILD
SPOUSE - SPOUSE
DOMESTIC_PARTNER - DOMESTIC_PARTNER

Allowed values:

employeestring or nullOptionalformat: "uuid"

The employee this person is a dependent of.

date_of_birthdatetime or nullOptional

The dependent's date of birth.

remote_datalist of objects or nullOptionalRead-only

Supported response fields

remote_idstring or nullOptional

The third-party API ID of the matching object.

first_namestring or nullOptional<=60 characters

The dependents's first name.

middle_namestring or nullOptional<=60 characters

The dependents's middle name.

last_namestring or nullOptional<=60 characters

The dependents's last name.

relationshipenum or nullOptional

The dependent’s relationship to the employee.

CHILD - CHILD
SPOUSE - SPOUSE
DOMESTIC_PARTNER - DOMESTIC_PARTNER

Allowed values:

employeestring or nullOptionalformat: "uuid"

The employee this person is a dependent of.

date_of_birthdatetime or nullOptional

The dependent's date of birth.

genderenum or nullOptional

The dependent’s gender.

MALE - MALE
FEMALE - FEMALE
NON-BINARY - NON-BINARY
OTHER - OTHER
PREFER_NOT_TO_DISCLOSE - PREFER_NOT_TO_DISCLOSE

Allowed values:

phone_numberstring or nullOptional<=50 characters

The dependent's phone number.

home_locationstring or nullOptionalformat: "uuid"

The dependents's home address.

is_studentboolean or nullOptional

Whether or not the dependent is a student

ssnstring or nullOptional<=50 characters

The dependents's social security number.

remote_datalist of objects or nullOptionalRead-only

Authentication

Headers

Query parameters

Response

Field support by integration

Field support by integration