Skip to main content
GET
/
v1
/
company-benefits
/
{company_benefit_id}
/
eligible-expense-categories
List eligible expense categories for a benefit
curl --request GET \
  --url https://api.vitablehealth.com/v1/company-benefits/{company_benefit_id}/eligible-expense-categories \
  --header 'X-Partner-API-Key: <api-key>'
{
  "eligible_expense_categories": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "expense_category": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "created": "2023-11-07T05:31:56Z",
        "updated": "2023-11-07T05:31:56Z",
        "description": "<string>"
      },
      "expense_category_name": "<string>",
      "company_benefit_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created": "2023-11-07T05:31:56Z",
      "updated": "2023-11-07T05:31:56Z",
      "expense_category_description": "<string>"
    }
  ]
}

Authorizations

X-Partner-API-Key
string
header
required

Partner API key for external integrations

Path Parameters

company_benefit_id
string<uuid>
required

Unique identifier for the company benefit

Response

200 - application/json

List of eligible expense categories

Response containing eligible expense categories for a benefit

eligible_expense_categories
object[]
required

List of eligible expense categories