Skip to main content
GET
Get Dependent Benefit By Id

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

The Hris Dependent Benefit object is used to represent a benefit that an dependent has enrolled in.

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 | null
required

The custom fields related to the model

Example:
employer_benefit
any | null
required

The employer benefit plan the dependent is enrolled in.

Example:

"018b18ef-c488-7d40-9131-91bbc47c1007"

dependent
any | null
required

The dependent which belongs to this benefit.

Example:

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

start_date
string | null
required

The day and time the benefit started.

Example:

"2023-10-18T00:00:00Z"

effective_date
string | null
required

The day and time the benefit is effective from.

Example:

"2023-10-18T00:00:00Z"

end_date
string | null
required

The day and time the benefit ended.

Example:

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

raw_data
Raw Data · object | null

This is the Raw data

Example: