BIbindbee
Employer Benefits

Get Employer Benefits

Changed on

Returns a list of Employer Benefit objects.

get/api/hris/v1/employer-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 employer 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
payroll_code_idstring nullable

The IDs of the payroll codes to fetch employer benefits for. A benefit matches when any of its payroll codes is one of these.

Example:019fbd01-e394-76ed-93fb-b9eda49a3b41,019fbd01-e5ea-7d5a-a602-bd9016a271cc
remote_idstring nullable

The third-party API ID of the matching object.

Example:3235005483341316245
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.

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

  • 1f9bc0ad4bfbRevision 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 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 HEALTH_SAVINGS 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 OTHER 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 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 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 WELLNESS enum value from the // response property for the response status

  • 4695175eeff0Revision changes
    • info

      added the new optional query request parameter payroll_code_id