---
title: "Get Benefits"
method: GET
path: "/api/hris/v1/benefits"
tags: ["Benefits"]
---

# Get Benefits

`GET /api/hris/v1/benefits`

Returns a list of Benefit objects.

## Query parameters

- `ids` string, nullable — The ID of the benefits to fetch
- `employee_id` string, nullable — The ID of the employees for the benefits to fetch
- `employer_benefit_id` string, nullable — The ID of the employer benefits for the benefits to fetch
- `benefit_plan_category` string — The category of the benefit plan to filter by (e.g., MEDICAL, VISION, DENTAL, RETIREMENT, etc.)
- `remote_id` string — The third-party API ID of the matching object.
- `coverage_tier` string, nullable — The coverage tier of the benefit to filter by
- `include_raw_data` boolean — Whether to include the original data Bindbee fetched from the third-party to produce these models.
- `include_custom_fields` boolean — 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)
- `page_size` integer — Number of results to return per page. Maximum size is 200.
- `cursor` string — The pagination cursor value.
- `start_date_from` string — If provided, only objects with start_date same or after this date time will be returned. Format: DateTime (ISO 8601)
- `start_date_to` string — If provided, only objects with start_date same or before this date time will be returned. Format: DateTime (ISO 8601)
- `end_date_from` string — If provided, only objects with end_date same or after this date time will be returned. Format: DateTime (ISO 8601)
- `end_date_to` string — If provided, only objects with end_date same or before this date time will be returned. Format: DateTime (ISO 8601)
- `effective_date_from` string — If provided, only objects with effective_date same or after this date time will be returned. Format: DateTime (ISO 8601)
- `effective_date_to` string — If provided, only objects with effective_date same or before 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.

## Headers

- `x-connector-token` string, required

## Response `200`

Successful Response

- PaginatedResponseHrisBenefit
  - `cursor` string, nullable, required — Cursor value to fetch next set of items
  - `page_size` integer, required — Indicates the count of items in the response
  - `items` HrisBenefit[], required — List of items in the current response
    - `id` string, uuid, required
    - `remote_id` string, nullable, required — The third-party API ID of the matching object.
    - `modified_at` string, required — This is the datetime that this object was last updated by Bindbee
    - `raw_data` object, nullable — This is the Raw data
    - `custom_fields` object, nullable, required — The custom fields related to the model
    - `employee` string, nullable, required — The employee on the plan.
    - `plan_name` string, nullable, required — The name of the plan.
    - `provider_name` string, nullable, required — The name of the benefit provider.
    - `benefit_plan_type` string, nullable, required — The type of benefit plan
    - `frequency` 'HOURLY' | 'WEEKLY' | 'BIWEEKLY' | 'QUARTERLY' | 'SEMIANNUALLY' | 'ANNUALLY' | 'THIRTEEN-MONTHLY' | 'PRO_RATA' | 'SEMIMONTHLY' | 'MONTHLY' | 'FOURWEEKLY' | '-', nullable, 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.
    - `employee_contribution` union, required — The employee's contribution.
      - number
      - integer
    - `company_contribution` union, required — The company's contribution.
      - number
      - integer
    - `start_date` string, nullable, required — The day and time the benefit started.
    - `effective_date` string, nullable, required — The day and time the benefit is effective from.
    - `end_date` string, nullable, required — The day and time the benefit ended.
    - `employer_benefit` string, nullable, required — The employer benefit plan the employee is enrolled in.
    - `benefit_plan_category` 'MEDICAL' | 'VISION' | 'DENTAL' | 'HEALTH_SAVINGS' | 'FLEXIBLE_SPENDING' | 'LIFE_INSURANCE' | 'DISABILITY' | 'SUPPLEMENTAL_INSURANCE' | 'RETIREMENT' | 'WELLNESS' | 'OTHER', nullable, 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.
    - `coverage_tier` 'WAIVED' | 'EMPLOYEE_ONLY' | 'EMPLOYEE_SPOUSE' | 'EMPLOYEE_CHILD' | 'EMPLOYEE_CHILDREN' | 'EMPLOYEE_FAMILY' | 'EMPLOYEE_DOMESTIC_PARTNER' | 'HSA_FAMILY' | 'SPOUSE' | 'EMPLOYEE_1_DEPENDENT' | 'EMPLOYEE_1_HOUSEHOLD_MEMBER', nullable, 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.

## Other responses

- `401` — Missing or invalid bearer authentication credentials.
- `403` — The credentials are valid but do not permit access to this resource, e.g. a connector token used on a different API category or a model whose writes are disabled.
- `422` — Validation Error
- `429` — Rate limit exceeded.

---

[API](https://skmtc.net/bindbee/apis/bindbee-apis.md) · [All operations](https://skmtc.net/bindbee/apis/bindbee-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bindbee/bindbee-apis/revisions/7da10dc93a21/schema)