Skip to main content
GET
/
v1
/
companies
/
{company_id}
/
benefits
List active benefit plans for a company
curl --request GET \
  --url https://api.vitablehealth.com/v1/companies/{company_id}/benefits \
  --header 'X-Partner-API-Key: <api-key>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "benefit_name": "<string>",
      "benefit_code": "<string>",
      "benefit_type": "<string>",
      "plan_year_start": "2023-12-25",
      "plan_year_end": "2023-12-25",
      "enrollment_start": "2023-12-25",
      "enrollment_end": "2023-12-25",
      "is_active": true
    }
  ],
  "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

Response

200 - application/json

List of active company benefits

data
object[]
pagination
object