Sign in
Employer Benefits

Get Employer Benefits

Returns a list of Employer Benefit objects.

get/api/hris/v1/employer-benefits

Query parameters

idsstring nullable

The ID of the employer benefits to fetch

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

The ID of the employer benefits to fetch

benefit_plan_categorystring nullable

The category of the benefit plan to filter by (e.g., MEDICAL, VISION, DENTAL, RETIREMENT, etc.)

Example:MEDICAL

The category of the benefit plan to filter by (e.g., MEDICAL, VISION, DENTAL, RETIREMENT, etc.)

remote_idstring nullable

The third-party API ID of the matching object.

Example:3235005483341316245

The third-party API ID of the matching object.

include_raw_databoolean

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_fieldsboolean

Whether to include custom fields in the response.

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

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.

page_sizeinteger

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

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

cursorstring nullable

The pagination cursor value.

The pagination cursor value.

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.

Example:manager[first_name,last_name]

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-tokenstring required

Response

Successful Response

cursorstring nullable required

Cursor value to fetch next set of items

page_sizeinteger required

Indicates the count of items in the response

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"
      },
      "plan_name": "Medical PPO",
      "provider_name": "Anthem",
      "benefit_plan_type": "Medical",
      "deduction_code": "MEDPPO",
      "description": "Preferred Provider Organization (PPO) plan with medical coverage.",
      "benefit_plan_category": "MEDICAL",
      "start_date": "2023-10-18T00:00:00Z",
      "end_date": "2024-10-16T00:00:00Z",
      "payroll_codes": [
        "018abccb-c4a9-72f6-be1d-3fc7aaf2be67"
      ]
    }
  ]
}

Changes

Changed in 3 of the 11 revisions of this API.15

  • a606b0cf18c910See the full diff
    • ○

      query request parameter benefit_plan_category list-of-types was widened by adding types null

      request-parameter-list-of-types-widened

    • ○

      query request parameter cursor list-of-types was widened by adding types null

      request-parameter-list-of-types-widened

    • ○

      query request parameter expand list-of-types was widened by adding types null

      request-parameter-list-of-types-widened

    • ○

      query request parameter modified_after list-of-types was widened by adding types null

      request-parameter-list-of-types-widened

    • ○

      query request parameter remote_id list-of-types was widened by adding types null

      request-parameter-list-of-types-widened

    • ○

      for the query request parameter benefit_plan_category, the type/format was generalized from string/ to /

      request-parameter-type-generalized

    • ○

      for the query request parameter cursor, the type/format was generalized from string/ to /

      request-parameter-type-generalized

    • ○

      for the query request parameter expand, the type/format was generalized from string/ to /

      request-parameter-type-generalized

    • ○

      for the query request parameter modified_after, the type/format was generalized from string/ to /

      request-parameter-type-generalized

    • ○

      for the query request parameter remote_id, the type/format was generalized from string/ to /

      request-parameter-type-generalized

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 6f24c7fcb3f82See the full diff
    • ○

      added the new optional query request parameter expand

      new-optional-request-parameter

    • ○

      added the optional property items/items/payroll_codes to the response with the 200 status

      response-optional-property-added

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • eb3486b88e553See the full diff
    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    • ○

      added the non-success response with the status 429

      response-non-success-status-added