Skip to main content
GET
/
v1
/
companies
/
{company_id}
/
benefit-eligibilities
List employee benefit eligibilities
curl --request GET \
  --url https://api.vitablehealth.com/v1/companies/{company_id}/benefit-eligibilities \
  --header 'X-Partner-API-Key: <api-key>'
{
  "data": [
    {
      "employee_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "employee_name": "<string>",
      "benefit_eligibilities": [
        {
          "benefit_name": "<string>",
          "benefit_code": "<string>",
          "eligible": true,
          "eligibility_date": "2023-12-25",
          "waiting_period_days": 123
        }
      ]
    }
  ],
  "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

employee_name
string

Filter by employee name

terminated_in
boolean

Include terminated employees

limit
integer
default:20

Number of results to return per page

page
integer
default:1

Page number for pagination

Response

200 - application/json

List of employee benefit eligibilities

data
object[]
pagination
object