Skip to main content
GET
/
api
/
hris
/
v1
/
benefits
/
{id}
Get Benefit By Id
curl --request GET \
  --url https://api.bindbee.dev/api/hris/v1/benefits/{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": "018b18ef-c488-7d40-9131-91bbc47c1007",
  "plan_name": "401(k) Plan",
  "provider_name": "Metlife",
  "benefit_plan_type": "Health Insurance",
  "frequency": "SEMIMONTHLY",
  "employee_contribution": 22.27,
  "company_contribution": 77.22,
  "start_date": "2023-10-18T00:00:00Z",
  "effective_date": "2023-10-18T00:00:00Z",
  "end_date": "2024-10-16T00:00:00Z",
  "employer_benefit": "018b18ef-c488-7d40-9131-91bbc47c1007",
  "benefit_plan_category": "MEDICAL",
  "coverage_tier": "EMPLOYEE_ONLY",
  "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

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
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 on the plan.

Example:

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

​
plan_name
string | null
required

The name of the plan.

Example:

"401(k) Plan"

​
provider_name
string | null
required

The name of the benefit provider.

Example:

"Metlife"

​
benefit_plan_type
string | null
required

The type of benefit plan

Example:

"Health Insurance"

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

Available options:
HOURLY,
WEEKLY,
BIWEEKLY,
QUARTERLY,
SEMIANNUALLY,
ANNUALLY,
THIRTEEN-MONTHLY,
PRO_RATA,
SEMIMONTHLY,
MONTHLY,
FOURWEEKLY,
-
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
enum<string>
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.

Available options:
MEDICAL,
VISION,
DENTAL,
HEALTH_SAVINGS,
FLEXIBLE_SPENDING,
LIFE_INSURANCE,
DISABILITY,
SUPPLEMENTAL_INSURANCE,
RETIREMENT,
WELLNESS,
OTHER
Example:

"MEDICAL"

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

Available options:
WAIVED,
EMPLOYEE_ONLY,
EMPLOYEE_SPOUSE,
EMPLOYEE_CHILD,
EMPLOYEE_CHILDREN,
EMPLOYEE_FAMILY,
EMPLOYEE_DOMESTIC_PARTNER,
HSA_FAMILY,
SPOUSE,
EMPLOYEE_1_DEPENDENT,
EMPLOYEE_1_HOUSEHOLD_MEMBER
Example:

"EMPLOYEE_ONLY"

​
raw_data
Raw Data · object

This is the Raw data

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