API ReferencePlans

List all plans

Returns a list of plans.

Authentication

AuthorizationBearer
Authorization header using the Bearer scheme

Query parameters

typestringOptional

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

provider_idstringOptional

Multiple values can be provided by separating them with a comma. Allowed values are: allianz, irish_life_health, vitality, onvz, freedom, sanitas, canada_life, hallesche, bupa, dansk_sundhedssikring.

countryobjectOptional
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.
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_pageboolean or nullRead-only
Whether there are more pages available after this page
has_previous_pageboolean or nullRead-only
Whether there are more pages available before this page

Errors