Get Dependents - Bindbee Docs

GET

api

hris

dependents

curl --request GET \
  --url https://api.bindbee.dev/api/hris/v1/dependents \
  --header 'Authorization: Bearer <token>' \
  --header 'x-connector-token: <x-connector-token>'

{
  "cursor": "MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1",
  "page_size": 50,
  "items": [
    {
      "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": "<any>",
      "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",
      "ssn": "555-22-5555"
    }
  ]
}

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

Query Parameters

employee_id

string

The ID of the employee.

remote_id

string

The third-party API ID of the matching object.

include_raw_data

boolean

default:false

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

include_custom_fields

boolean

default:false

Whether to include custom fields in the response.

page_size

integer

default:50

Number of results to return per page. Maximum size is 100.

Required range: 1 <= x <= 1000

cursor

string

The pagination cursor value.

modified_after

string

If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601)

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.

Response

200

application/json

Successful Response

cursor

string | null

required

Cursor value to fetch next set of items

Example:

"MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"

page_size

integer

required

Indicates the count of items in the response

Example:

50

items

object[]

required

items.id

string

required

Example:

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

items.remote_id

string | null

required

The third-party API ID of the matching object.

Example:

"123321"

items.modified_at

string

required

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

Example:

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

items.custom_fields

object | null

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

items.employee

any | null

required

The employee holding this position.

items.home_location

object | null

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

items.first_name

string | null

required

The dependent's first name

Example:

"Aayushi"

items.middle_name

string | null

required

The dependent's middle name

Example:

"Olivia"

items.last_name

string | null

required

The dependent's last name

Example:

"Rai"

items.relationship

string | null

required

The dependent's relationship with this employee

Example:

"SPOUSE"

items.date_of_birth

string | null

required

The dependent's date of birth

Example:

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

items.gender

string | null

required

The dependent's gender

Example:

"female"

items.phone_number

string | null

required

The dependent's phone number

Example:

"+44-208-555-2112"

items.ssn

string | null

required

The dependent's SSN

Example:

"555-22-5555"

items.raw_data

object | null

This is the Raw data

Example:

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

Get Employer Benefit By Id Get Dependent By Id

curl --request GET \
  --url https://api.bindbee.dev/api/hris/v1/dependents \
  --header 'Authorization: Bearer <token>' \
  --header 'x-connector-token: <x-connector-token>'

{
  "cursor": "MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1",
  "page_size": 50,
  "items": [
    {
      "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": "<any>",
      "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",
      "ssn": "555-22-5555"
    }
  ]
}

Unified Models

Authorizations

Headers

Query Parameters

Response