Skip to main content
GET
Get Benefit By Id

Authorizations

Authorization
string
header
default:<BINDBEE_API_KEY>
required

Your Bindbee API key, sent as Authorization: Bearer <BINDBEE_API_KEY>. Required on every request.

X-Connector-Token
string
header
default:<CONNECTOR_TOKEN>
required

The connector token for one customer's connection. This is not your Bindbee API key. Required on requests that read or write a single customer's data.

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

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 Benefit object is used to represent a benefit that an employee 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<date-time>
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:
employee
any | null
required

The employee on the plan.

Example:

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

plan_name
string | null
required

The name of the plan.

Example:

"Medical PPO"

provider_name
string | null
required

The name of the benefit provider.

Example:

"Anthem"

benefit_plan_type
string | null
required

The type of benefit plan

Example:

"Medical"

frequency
string | null
required

The frequency of the plan. If the value is not one of the defined enum values, the original value passed through will be returned.

Example:

"SEMIMONTHLY"

employee_contribution
required

The employee's contribution.

Example:

22.27

company_contribution
required

The company's contribution.

Example:

77.22

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"

employer_benefit
any | null
required

The employer benefit plan the employee is enrolled in.

Example:

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

benefit_plan_category
string | null
required

The category of the plan. If the value is not one of the defined enum values, the original value passed through will be returned.

Example:

"MEDICAL"

coverage_tier
string | null
required

The coverage tier for the benefit plan. If the value is not one of the defined enum values, the original value passed through will be returned.

Example:

"EMPLOYEE_ONLY"

raw_data
Raw Data · object | null

This is the Raw data

Example: