Get Employer Benefits - Bindbee Docs

GET

api

hris

employer-benefits

Get Employer Benefits

curl --request GET \
  --url https://api.bindbee.dev/api/hris/v1/employer-benefits \
  --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",
      "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"
      },
      "plan_name": "401(k) Plan",
      "provider_name": "Metlife",
      "benefit_plan_type": "Health Insurance",
      "deduction_code": "KT",
      "description": "KTO Silver Plan",
      "benefit_plan_category": "MEDICAL",
      "coverage_tiers": [
        "EMPLOYEE_SPOUSE",
        "EMPLOYEE_CHILDREN"
      ],
      "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

Query Parameters

ids

string | null

The ID of the employer benefits to fetch The ID of the employer benefits to fetch

remote_id

string

The third-party API ID of the matching object. 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. 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. Whether to include custom fields in the response.

modified_after

string

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

page_size

integer

default:50

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

Required range: 1 <= x <= 100

cursor

string

The pagination cursor value. The pagination cursor value.

Response

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

HrisEmployerBenefit · object[]

required

Show child attributes

items.id

string<uuid>

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

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

items.plan_name

string | null

required

The name of the plan.

Example:

"401(k) Plan"

items.provider_name

string | null

required

The name of the benefit provider.

Example:

"Metlife"

items.benefit_plan_type

string | null

required

The type of benefit plan

Example:

"Health Insurance"

items.deduction_code

string | null

required

The employer benefit's deduction code.

Example:

"KT"

items.description

string | null

required

The employer benefit's description.

Example:

"KTO Silver Plan"

items.benefit_plan_category

string | null

required

The category of the plan.

Example:

"MEDICAL"

items.coverage_tiers

string[] | null

required

The coverage tiers for the benefit plan.

Example:

["EMPLOYEE_SPOUSE", "EMPLOYEE_CHILDREN"]

items.raw_data

Raw Data · object

This is the Raw data

Example:

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

Get Employer Benefit By IdReturns a Employer Benefit object with the given id.

⌘I

Get Employer Benefits

curl --request GET \
  --url https://api.bindbee.dev/api/hris/v1/employer-benefits \
  --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",
      "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"
      },
      "plan_name": "401(k) Plan",
      "provider_name": "Metlife",
      "benefit_plan_type": "Health Insurance",
      "deduction_code": "KT",
      "description": "KTO Silver Plan",
      "benefit_plan_category": "MEDICAL",
      "coverage_tiers": [
        "EMPLOYEE_SPOUSE",
        "EMPLOYEE_CHILDREN"
      ],
      "raw_data": {
        "key_1": "Platform dependent data 1",
        "key_2": "Platform dependent data 2"
      }
    }
  ]
}

Unified Models

Authorizations

Headers

Query Parameters

Response