Sign in

v4

latestOpenAPI 3.1.02026-08-01139149645.9 KB
Dependents

Get Dependent By Id

Returns a Dependent object with the given id.

get/api/hris/v1/dependents/{id}

Path parameters

idstring uuid required

Query parameters

include_raw_databoolean

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

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

include_custom_fieldsboolean

Whether to include custom fields in the response.

Whether to include custom fields in the response.

expandstring

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.

Example:manager[first_name,last_name]

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.

Headers

x-connector-tokenstring required

Response

Successful Response

idstring uuid required
remote_idstring nullable required

The third-party API ID of the matching object.

modified_atstring required

This is the datetime that this object was last updated by Bindbee

raw_dataobject nullable

This is the Raw data

custom_fieldsobject nullable required

The custom fields related to the model

employeestring nullable required

The employee holding this position.

first_namestring nullable required

The dependent's first name

middle_namestring nullable required

The dependent's middle name

last_namestring nullable required

The dependent's last name

relationship'CHILD' | 'SPOUSE' | 'DOMESTIC_PARTNER' | 'SIBLING' | 'PARENT' nullable required

The dependent's relationship with this employee. If the value is not one of the defined enum values, the original value passed through will be returned.

date_of_birthstring nullable required

The dependent's date of birth

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

The dependent's gender. If the value is not one of the defined enum values, the original value passed through will be returned.

phone_numberstring nullable required

The dependent's phone number

is_studentboolean nullable required

Indicates if the dependent is a student

ssnstring nullable required

The dependent's SSN

Example response

{
  "id": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
  "remote_id": "123321",
  "modified_at": "2021-10-16T00:00:00Z",
  "raw_data": {
    "key_1": "Platform dependent data 1",
    "key_2": "Platform dependent data 2"
  },
  "custom_fields": {
    "category_group": "REG",
    "disability_type": "ASBERG",
    "hire_date": "1991-03-16T00:00:00",
    "hire_source": "REFER",
    "nationality": "USA",
    "original_hire_date": "1991-03-16T00:00:00"
  },
  "employee": "018abccb-c4a9-72f6-be1d-3fc7aaf2be67",
  "home_location": {
    "name": "UK-HO-London",
    "location": "UK-HO-London",
    "street_1": "1011",
    "street_2": "Lane number 4, Golden Villa",
    "city": "London",
    "state": "LND",
    "postal_code": "56273",
    "country": "UK"
  },
  "first_name": "Aayushi",
  "middle_name": "Olivia",
  "last_name": "Rai",
  "relationship": "SPOUSE",
  "date_of_birth": "1995-04-16T00:00:00Z",
  "gender": "FEMALE",
  "phone_number": "+44-208-555-2112",
  "is_student": true,
  "ssn": "555-22-5555"
}