Skip to content
Vitable Docs Vitable Docs Vitable Docs
API Reference
Benefit Eligibility Policies

Get eligibility policy details

benefit_eligibility_policies.retrieve(strpolicy_id) -> BenefitEligibilityPolicyResponse
GET/v1/benefit-eligibility-policies/{policy_id}

Retrieves a benefit eligibility policy by ID.

ParametersExpand Collapse
policy_id: str

Unique benefit eligibility policy identifier (epol_*)

ReturnsExpand Collapse
class BenefitEligibilityPolicyResponse: …

Response containing a single benefit eligibility policy resource.

id: str
active: bool
classification: str
created_at: datetime
formatdate-time
employer_id: str
updated_at: datetime
formatdate-time
waiting_period: str

Get eligibility policy details

import os
from vitable_connect import VitableConnect

client = VitableConnect(
    api_key=os.environ.get("VITABLE_CONNECT_API_KEY"),  # This is the default and can be omitted
)
benefit_eligibility_policy_response = client.benefit_eligibility_policies.retrieve(
    "epol_abc123def456",
)
print(benefit_eligibility_policy_response.data)
{
  "data": {
    "id": "id",
    "active": true,
    "classification": "classification",
    "created_at": "2019-12-27T18:11:19.117Z",
    "employer_id": "employer_id",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "waiting_period": "waiting_period"
  }
}
Returns Examples
{
  "data": {
    "id": "id",
    "active": true,
    "classification": "classification",
    "created_at": "2019-12-27T18:11:19.117Z",
    "employer_id": "employer_id",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "waiting_period": "waiting_period"
  }
}