Skip to main content
GET
/
api
/
hris
/
v1
/
dependents
/
{id}
Get Dependent By Id
curl --request GET \
  --url https://api.bindbee.dev/api/hris/v1/dependents/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'x-connector-token: <x-connector-token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "remote_id": "123321",
  "modified_at": "<string>",
  "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": {
    "city": "London",
    "country": "UK",
    "location": "UK-HO-London",
    "postal_code": "56273",
    "state": "LND",
    "street_1": "1011",
    "street_2": "Lane number 4, Golden Villa"
  },
  "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",
  "raw_data": {
    "key_1": "Platform dependent data 1",
    "key_2": "Platform dependent data 2"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-connector-token
string
required

Path Parameters

​
id
string<uuid>
required

Query Parameters

​
include_raw_data
boolean
default:false

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

Example:

false

​
include_custom_fields
boolean
default:false

Whether to include custom fields in the response.

Example:

false

​
expand
string

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]"

Response

Successful Response

​
id
string<uuid>
required
Example:

"018b18ef-c487-703c-afd9-0ca478ccd9d6"

​
remote_id
string | null
required

The third-party API ID of the matching object.

Example:

"123321"

​
modified_at
string
required

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

Example:

"2021-10-16T00:00:00Z"

​
custom_fields
Custom Fields · object
required

The custom fields related to the model

Example:
{
  "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
any | null
required

The employee holding this position.

Example:

"018abccb-c4a9-72f6-be1d-3fc7aaf2be67"

​
home_location
HrisAddress · object
required

The employee's home address.

Example:
{
  "city": "London",
  "country": "UK",
  "location": "UK-HO-London",
  "postal_code": "56273",
  "state": "LND",
  "street_1": "1011",
  "street_2": "Lane number 4, Golden Villa"
}
​
first_name
string | null
required

The dependent's first name

Example:

"Aayushi"

​
middle_name
string | null
required

The dependent's middle name

Example:

"Olivia"

​
last_name
string | null
required

The dependent's last name

Example:

"Rai"

​
relationship
enum<string>
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.

Available options:
CHILD,
SPOUSE,
DOMESTIC_PARTNER,
SIBLING,
PARENT
Example:

"SPOUSE"

​
date_of_birth
string | null
required

The dependent's date of birth

Example:

"1995-04-16T00:00:00Z"

​
gender
enum<string>
required

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

Available options:
MALE,
FEMALE,
NON-BINARY,
OTHER,
PREFER_NOT_TO_DISCLOSE,
-
Example:

"FEMALE"

​
phone_number
string | null
required

The dependent's phone number

Example:

"+44-208-555-2112"

​
is_student
boolean | null
required

Indicates if the dependent is a student

Example:

true

​
ssn
string | null
required

The dependent's SSN

Example:

"555-22-5555"

​
raw_data
Raw Data · object

This is the Raw data

Example:
{
  "key_1": "Platform dependent data 1",
  "key_2": "Platform dependent data 2"
}