Skip to navigation
API ReferencePlans

List all plans

Returns a list of plans.

Authentication

AuthorizationBearer
Authorization header using the Bearer scheme

Headers

X-Platform-IdstringOptional

The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.

Query parameters

typestringOptional

Multiple values can be provided by separating them with a comma. Allowed values are: health_insurance, life_assurance.

provider_idstringOptional

Multiple values can be provided by separating them with a comma. Allowed values are: pr_allianz, pr_irishlifehealth, pr_vitality, pr_onvz, pr_freedom, pr_sanitas, pr_canadalife, pr_hallesche, pr_bupa, pr_dansksundhedssikring, pr_allianzkpt, pr_freedomuk, pr_bupaglobal, pr_expatriate, pr_gsmc, pr_axafrance.

countryenumOptional
Filters plans by country.
available_ondateOptional
Filters plans available on a specific date. Defaults to today.
group_idstringOptionalformat: "gr_.+"
Filters plans by group eligibility. Only plans whose eligibility criteria match the group are returned. Criteria that cannot be evaluated are ignored.
start_datedateOptional

Reference date used to compute employee age when evaluating per-plan eligibility counts. Required together with group_id for counts to be included in the response.

sort_byenumOptional

Sorts plans by a specific field. Currently only premium is supported.

Allowed values:
sort_direnumOptional

Sort direction. Defaults to asc (ascending).

Allowed values:
pageintegerOptional
The page of results to return. Defaults to 1 if not provided.
page_sizeintegerOptional
The number of results to return per page. Defaults to 10 if not provided. Maximum value is 100.

Response

OK
itemslist of objects
A paginated array containing the response elements
pageinteger
The current page of the results
page_sizeinteger
The number of results on this page. This can be different from the requested page size if the total number of results is less than the requested page size
total_countinteger
The total number of elements available in the response. This is the total number of elements available across all pages, not just the current page.
has_next_pagebooleanOptionalRead-only
Whether there are more pages available after this page
has_previous_pagebooleanOptionalRead-only
Whether there are more pages available before this page

Errors

400
Bad Request Error
404
Not Found Error