curl --request GET \
--url https://api.vitablehealth.com/v1/company-benefits/{company_benefit_id} \
--header 'X-Partner-API-Key: <api-key>'{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "EBA",
"name": "<string>",
"internal_name": "<string>",
"vitable_managed_in": true,
"plans": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"level": 123,
"tier_costs": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"benefit_plan_tier_name": "<string>",
"cost": 123,
"cost_per_dependent": 123,
"dependents_required_in": true,
"spouse_required_in": true
}
],
"min_tier_cost": 123,
"max_dependent_cost": 123,
"vitable_only_in": true,
"employee_enrollment_count": 123,
"dependent_enrollment_count": 123
}
],
"eligibility_rules": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"readable_expression_str": "<string>",
"employment": "Unspecified",
"compensation": "Unspecified",
"location": "Unspecified",
"location_value": "<string>"
}
],
"open_enrollment_start": "2023-12-25",
"coverage_start": "2023-12-25",
"carrier_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"carrier": "Essential Benefit Administrators",
"active_in": true,
"configured_in": true,
"allowance_based_in": true,
"health_wallet_enabled_in": true,
"open_enrollment_end": "2023-12-25",
"coverage_end": "2023-12-25"
}
}Retrieve detailed information about a specific company benefit. Provides comprehensive benefit details including plans, eligibility rules, expense categories, pricing, and configuration information.
curl --request GET \
--url https://api.vitablehealth.com/v1/company-benefits/{company_benefit_id} \
--header 'X-Partner-API-Key: <api-key>'{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "EBA",
"name": "<string>",
"internal_name": "<string>",
"vitable_managed_in": true,
"plans": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"level": 123,
"tier_costs": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"benefit_plan_tier_name": "<string>",
"cost": 123,
"cost_per_dependent": 123,
"dependents_required_in": true,
"spouse_required_in": true
}
],
"min_tier_cost": 123,
"max_dependent_cost": 123,
"vitable_only_in": true,
"employee_enrollment_count": 123,
"dependent_enrollment_count": 123
}
],
"eligibility_rules": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"readable_expression_str": "<string>",
"employment": "Unspecified",
"compensation": "Unspecified",
"location": "Unspecified",
"location_value": "<string>"
}
],
"open_enrollment_start": "2023-12-25",
"coverage_start": "2023-12-25",
"carrier_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"carrier": "Essential Benefit Administrators",
"active_in": true,
"configured_in": true,
"allowance_based_in": true,
"health_wallet_enabled_in": true,
"open_enrollment_end": "2023-12-25",
"coverage_end": "2023-12-25"
}
}Partner API key for external integrations
Unique identifier for the company benefit
Company benefit details
Show child attributes
Unique identifier for the benefit
Benefit type code
EBA, VPC, VPC_CORE, MEC, MEC2, MEC_PLUS, MVP, MVP2, MVPSL, MVPSL2, VD, VV, ICHRA, ICHRA_PREMIUM_PLUS Benefit display name
Internal benefit name
Whether benefit is managed by Vitable
Available benefit plans
Show child attributes
Plan identifier
Company identifier
Plan name
Plan level/tier
Cost information by tier
Show child attributes
Tier cost identifier
Tier name
Employee cost in cents
Per-dependent cost in cents
Whether dependents are required
Whether spouse is required
Minimum tier cost in cents
Maximum dependent cost in cents
Whether plan is Vitable-only
Number of employees enrolled
Number of dependents enrolled
Benefit eligibility rules
Show child attributes
Rule identifier
Human-readable rule expression
Employment type requirement
Unspecified, Full Time, Part Time, Temporary, Seasonal Compensation type requirement
Unspecified, Salary, Hourly Location requirement type
Unspecified, State Location requirement value
Open enrollment start date
Coverage start date
Insurance carrier ID
Insurance carrier name
Essential Benefit Administrators, Liferaft, Imagine360, Vitable, TrueClaim Whether benefit is currently active
Whether benefit is properly configured
Whether benefit uses allowance-based pricing
Whether health wallet is enabled
Open enrollment end date
Coverage end date