GET
/
api
/
hris
/
v1
/
benefits
curl --request GET \
  --url https://api.bindbee.dev/api/hris/v1/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",
      "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": "<any>",
      "plan_name": "401(k) Plan",
      "provider_name": "Metlife",
      "benefit_plan_type": "MED",
      "frequency": "SEMIMONTHLY",
      "employee_contribution": 22.27,
      "company_contribution": 77.22,
      "start_date": "2023-10-18T00:00:00Z",
      "effective_date": "2023-10-18T00:00:00Z",
      "end_date": "2024-10-16T00:00:00Z",
      "employer_benefit": "<any>"
    }
  ]
}

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

​
employee_id
string

The ID of the employee.

​
employer_benefit_id
string

The ID of the employer benefit.

​
remote_id
string

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.

​
include_custom_fields
boolean
default:false

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
default:50

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

Required range: 1 <= x <= 1000
​
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.

Response

200
application/json
Successful Response

The response is of type object.