Skip to main content
GET
Get Employer Benefits

Authorizations

Authorization
string
header
default:<BINDBEE_API_KEY>
required

Your Bindbee API key, sent as Authorization: Bearer <BINDBEE_API_KEY>. Required on every request.

X-Connector-Token
string
header
default:<CONNECTOR_TOKEN>
required

The connector token for one customer's connection. This is not your Bindbee API key. Required on requests that read or write a single customer's data.

Query Parameters

ids
string | null

The ID of the employer benefits to fetch

Example:

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

benefit_plan_category
string | null

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_id
string | null

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_id
string | null

The third-party API ID of the matching object.

Example:

"3235005483341316245"

include_raw_data
boolean
default:false

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

Example:

false

include_custom_fields
boolean
default:false

Whether to include custom fields in the response.

Example:

false

modified_after
string | null

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

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

Required range: 1 <= x <= 200
cursor
string | null

The pagination cursor value.

expand
string | null

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]"

Response

Successful Response

cursor
string | null
required

Cursor value to fetch next set of items

Example:

"MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"

page_size
integer
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:

50

items
HrisEmployerBenefit · object[]
required

List of items in the current response