Skip to main content
GET
/
v1
/
companies
/
{company_id}
/
company-benefits
Search company benefits
curl --request GET \
  --url https://api.vitablehealth.com/v1/companies/{company_id}/company-benefits \
  --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"
    }
  ],
  "pagination": {
    "page": 123,
    "limit": 123,
    "total_count": 123,
    "total_pages": 123
  }
}

Authorizations

X-Partner-API-Key
string
header
required

Partner API key for external integrations

Path Parameters

company_id
string<uuid>
required

Unique identifier for the company

Query Parameters

active_in
boolean

Filter for active benefits only

configured_in
boolean

Filter for configured benefits only

non_expired_coverage_and_subscription_in
boolean

Filter for benefits with non-expired coverage and subscriptions

Response

200 - application/json

List of matching company benefits

data
object[]
pagination
object