dependents

Retrieve

Returns a Dependent object with the given id.<Footer>{/* BEGIN_HRIS_DEPENDENT_FETCH_SUPPORTED_FIELDS /}<MergeSupportedFieldsByIntegrationWidget requestType="GET" data="H4sIAAAAAAAAA81U72/aMBD9Vyp/RCEZpWwr0jRRYNB2BEZhW1VV1hEficGxg+2UQtX/fQqEDrauWn9o68e7vHu+e/cuNyQAi6HSC1IlkeaGOCRWDAWpkgYmKBlKSxwCCfchxhxEr/aJQ0yaJEpbZJ84CmbaGsekSrwYdYjFVPIxR+ZlcI9Li6EGy5U03l1ZcbyqIw4RXE6R1YJApdI+RLQGFmGN/CXMPpus2QSMsZFWaRj1cZaieZAz60dgjNKCKDKw4G3VF/Wa4L5c1jlDgRZZAyw00GKQjZi/FVmbmKrnRSgSd/Wuy/DKQ+mBtjwQaLxK+XD/3WGlmLOsXv9IQ/GhVJjMRmr0rkDDQFBIC51BcO0Pjuf+JDzw6wfX/nJY8ZfTpT+ZvinQEAqdQafSHZyXu41aqXsPgJ69/X749ahxdOIXgmWz7E/O5/4gKHUGwXS0PC6ftIL5SfvLtb883+80hmV/0KyctFSpW++bTr2vOjXXJQ7Z3iSpXtxsJ3KDHEE8Uqrd30UfxxDilirrRUDCi0k6EjxwTdmFGJZKwty4gYq9GBkHb8NGz2YpaKSfVajcSRJutOdK3glPqqTpt2t+vdnYdUHtCriAkUBStTrF36xLqheEgUWqxnTEtY2IQzBOhFogEoeMuTaWymw8h4TZTWjikEjFSIUKVuNlwxpqbJrfi4CfFTFnTOAmSiIlkco0Hq1YNIq1mhFPVmGsLNLMCLsRTWDVVp7iLDtAI8lllpqlXCPrgYYYLepsnstb577lNGAxVjrAl1lOT4AdKx1vWN1EvoLF/HERj9X6Cfq2+3s90FauG3m+wu1+TvfP/b+j7V+ZlrPHqjU8be31EdjiZcQanraoWcsUIrTfz3r/1ZDPsd6TJf2m9JTBCwm6ue+c9HWc92v/717e/gDSDj3LVQkAAA==" />{/ END_HRIS_DEPENDENT_FETCH_SUPPORTED_FIELDS */}</Footer>

get/hris/v1/dependents/{id}

Request

  • Base URL: https://api.merge.dev/api
  • URL: https://api.merge.dev/api/hris/v1/dependents/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Query parameters

include_remote_databoolean

Whether to include the original data Merge fetched from the third-party to produce these models.

include_sensitive_fieldsboolean

Whether to include sensitive fields (such as social security numbers) in the response.

include_shell_databoolean

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

Headers

X-Account-Tokenstring required

Token identifying the end user.

Response

idstring uuid
remote_idstring nullable

The third-party API ID of the matching object.

created_atstring date-time

The datetime that this object was created by Merge.

modified_atstring date-time

The datetime that this object was modified by Merge.

first_namestring nullable

The dependents's first name.

middle_namestring nullable

The dependents's middle name.

last_namestring nullable

The dependents's last name.

relationship'CHILD' | 'SPOUSE' | 'DOMESTIC_PARTNER'
employeestring uuid nullable

The employee this person is a dependent of.

date_of_birthstring date-time nullable

The dependent's date of birth.

gender'MALE' | 'FEMALE' | 'NON-BINARY' | 'OTHER' | 'PREFER_NOT_TO_DISCLOSE'
phone_numberstring nullable

The dependent's phone number.

home_locationstring uuid nullable

The dependents's home address.

is_studentboolean nullable

Whether or not the dependent is a student

ssnstring nullable

The dependents's social security number.

remote_was_deletedboolean

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.

Changes

No recorded changes to this operation across all 1 revision of this API.