Activity3

Application3

Attachment3

Bank Info2

Benefit Coverages2

Benefits2

Candidate5

Categories2

COBRA Events2

Company2

Compensation2

Completions2

Connector8

Contents2

Courses2

Custom Fields12

Department3

Dependent Benefits2

Dependents2

EEOC3

Employee5

Employee Payroll Runs4

Employee Skills2

Employer Benefits2

Employments2

Enrollments2

Group2

Health Check1

Integration3

Job3

Job Interview Stage3

Learning Skills2

Link1

Location2

Lookup2

Offer3

Office3

Passthrough1

Pay Groups2

Payroll Codes2

Payroll Run Calendars2

Payroll Runs2

Performance Review Items2

Performance Reviews2

Reject Reason3

Remote User3

Scheduled Interview3

Scorecard3

Screening Question3

Skills2

Tag3

Time Off4

Time Off Balance2

Timesheet Entry4

Users2

Webhooks3

Benefits

Get Benefits

Changed on Oct 6, 2026

Returns a list of Benefit objects.

get/api/hris/v1/benefits

Request

Base URL
https://api.bindbee.dev (the document declares no server; this is the origin it was published from)
Auth
HTTP bearer and API key in header X-Connector-Token

Query parameters

idsstring nullable

The ID of the benefits to fetch

Example:01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a

employee_idstring nullable

The ID of the employees for the benefits to fetch

Example:01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a

employer_benefit_idstring nullable

The ID of the employer benefits for the benefits to fetch

Example:01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a

benefit_plan_categorystring nullable

The category of the benefit plan to filter by (e.g., MEDICAL, VISION, DENTAL, RETIREMENT, etc.). Pass several values, comma-separated, to match any of them.

Example:MEDICAL,DENTAL

remote_idstring nullable

The third-party API ID of the matching object.

Example:3235005483341316245

coverage_tierstring nullable

The coverage tier of the benefit to filter by. Pass several values, comma-separated, to match any of them.

Example:WAIVED

include_raw_databoolean

Whether to include the original data Bindbee fetched from the third-party to produce these models.

include_custom_fieldsboolean

Whether to include custom fields in the response.

modified_afterstring nullable

If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.

Example:2024-02-21T21:22:12.993Z

page_sizeinteger

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

cursorstring nullable

The pagination cursor value.

start_date_fromstring nullable

If provided, only objects with start_date same or after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.

Example:2024-02-21T21:22:12.993Z

start_date_tostring nullable

If provided, only objects with start_date same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.

Example:2024-02-21T21:22:12.993Z

end_date_fromstring nullable

If provided, only objects with end_date same or after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.

Example:2024-02-21T21:22:12.993Z

end_date_tostring nullable

If provided, only objects with end_date same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.

Example:2024-02-21T21:22:12.993Z

effective_date_fromstring nullable

If provided, only objects with effective_date same or after this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.

Example:2024-02-21T21:22:12.993Z

effective_date_tostring nullable

If provided, only objects with effective_date same or before this date time will be returned. Format: DateTime (ISO 8601). If no timezone offset is supplied, the value is interpreted as UTC.

Example:2024-02-21T21:22:12.993Z

expandstring nullable

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. Add .custom_fields to return an expanded record's custom fields, or .custom_fields[name,other_name] for only those (quote a name holding anything but letters, digits, _ and -: .custom_fields["wd:Visa_ID"]).

Example:manager[first_name,last_name]

Response

Successful Response

cursorstring nullable required

Cursor value to fetch next set of items

page_sizeinteger required

The page size the request was served with (0 on an empty page). items can be shorter on the last page; cursor says whether another page exists.

Example response

{
  "cursor": "MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1",
  "page_size": 50,
  "items": [
    {
      "id": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
      "remote_id": "123321",
      "modified_at": "2021-10-16T00:00:00Z",
      "raw_data": {
        "key_1": "Platform dependent data 1",
        "key_2": "Platform dependent data 2"
      },
      "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": "Medical PPO",
      "provider_name": "Anthem",
      "benefit_plan_type": "Medical",
      "frequency": "SEMIMONTHLY",
      "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"
    }
  ]
}

Changes

Oct 6, 20261f9bc0ad4bfb Revision changes
- info
  the endpoint scheme security HTTPBearer AND ConnectorToken was added to the API
- info
  the endpoint scheme security ConnectorToken was removed from the API
- info
  the endpoint scheme security HTTPBearer was removed from the API
- info
  removed the - enum value from the // response property for the response status
- info
  removed the ANNUALLY enum value from the // response property for the response status
- info
  removed the BIWEEKLY enum value from the // response property for the response status
- info
  removed the DENTAL enum value from the // response property for the response status
- info
  removed the DISABILITY enum value from the // response property for the response status
- info
  removed the EMPLOYEE_1_DEPENDENT enum value from the // response property for the response status
- info
  removed the EMPLOYEE_1_HOUSEHOLD_MEMBER enum value from the // response property for the response status
- info
  removed the EMPLOYEE_CHILD enum value from the // response property for the response status
- info
  removed the EMPLOYEE_CHILDREN enum value from the // response property for the response status
- info
  removed the EMPLOYEE_DOMESTIC_PARTNER enum value from the // response property for the response status
- info
  removed the EMPLOYEE_FAMILY enum value from the // response property for the response status
- info
  removed the EMPLOYEE_ONLY enum value from the // response property for the response status
- info
  removed the EMPLOYEE_SPOUSE enum value from the // response property for the response status
- info
  removed the FLEXIBLE_SPENDING enum value from the // response property for the response status
- info
  removed the FOURWEEKLY enum value from the // response property for the response status
- info
  removed the HEALTH_SAVINGS enum value from the // response property for the response status
- info
  removed the HOURLY enum value from the // response property for the response status
- info
  removed the HSA_FAMILY enum value from the // response property for the response status
- info
  removed the LIFE_INSURANCE enum value from the // response property for the response status
- info
  removed the MEDICAL enum value from the // response property for the response status
- info
  removed the MONTHLY enum value from the // response property for the response status
- info
  removed the OTHER enum value from the // response property for the response status
- info
  removed the PRO_RATA enum value from the // response property for the response status
- info
  removed the QUARTERLY enum value from the // response property for the response status
- info
  removed the RETIREMENT enum value from the // response property for the response status
- info
  removed the SEMIANNUALLY enum value from the // response property for the response status
- info
  removed the SEMIMONTHLY enum value from the // response property for the response status
- info
  removed the SPOUSE enum value from the // response property for the response status
- info
  removed the SUPPLEMENTAL_INSURANCE enum value from the // response property for the response status
- info
  removed the THIRTEEN-MONTHLY enum value from the // response property for the response status
- info
  removed the VISION enum value from the // response property for the response status
- info
  removed the WAIVED enum value from the // response property for the response status
- info
  removed the WEEKLY enum value from the // response property for the response status
- info
  removed the WELLNESS enum value from the // response property for the response status
Sep 27, 2026cf8209fb1cd7 Revision changes
- warning
  deleted the header request parameter x-connector-token
- info
  the endpoint scheme security ConnectorToken was added to the API

Operation history (4 revisions)

Get Benefits

Request

Query parameters

Response 200OK

Example response

Changes

Response