v1
latestOpenAPI 3.1.02026-07-242735131.1 MBBenefit Offers
List Benefit Offers
List benefit offers for each country.
Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage company resources (company_admin) | View benefit offers (benefit_offer:read) | Manage benefit offers (benefit_offer:write) |
get/v1/benefit-offers/country-summaries
Headers
Authorizationstring required
Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow.
The refresh token needs to have been obtained through the Authorization Code flow.
Response
Success
Example response
{
"data": {
"company_id": "79297cfd-cf60-4cf4-a70f-ac2061d72a74",
"country_summaries": [
{
"country": {
"alpha_2_code": "PT",
"code": "PRT",
"contractor_products_available": [
"standard",
"plus",
"cor"
],
"country_subdivisions": [
{
"code": "PT-06",
"name": "Coimbra",
"subdivision_type": "District"
},
{
"code": "PT-11",
"name": "Lisboa",
"subdivision_type": "District"
}
],
"employment_agreement_preview_available": true,
"eor_onboarding": true,
"locked_benefits": "after_first_hire",
"name": "Portugal",
"region": "Europe",
"subregion": "Southern Europe",
"supported_json_schemas": [
"additional_documents",
"address_details",
"administrative_details",
"employment-basic-information",
"bank_account_details",
"contract_details",
"emergency_contact"
]
},
"employee_stats": {
"number_of_employees_enrolled": 10,
"number_of_employees_offered": 12
},
"offered_benefit_groups": [
{
"benefit_group": {
"id": "54297cfd-cf60-4cf4-a70f-ac2061d72b44",
"name": "Health",
"policy_end_date": "2024-12-31",
"policy_start_date": "2024-01-01"
},
"employee_stats": {
"number_of_employees_enrolled": 10,
"number_of_employees_offered": 12
},
"offered_benefit_tiers": [
{
"benefit_tier": {
"description": "This is the premium tier for 2023 that includes medical, dental and vision benefits.",
"id": "66297cfd-cf60-4cf4-a70f-ac2561d92b04",
"name": "Premium 2023 (Medical, Dental and Vision)",
"providers": [
{
"id": "88297cfd-cf60-4cf4-a70f-ac2861d92b87",
"name": "Health Provider"
}
]
},
"employee_stats": {
"number_of_employees_enrolled": 10,
"number_of_employees_offered": 12
}
}
]
}
]
}
]
}
}