API Reference

Benefit Eligibility Policies

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get eligibility policy details

benefit_eligibility_policies.retrieve(policy_id) -> BenefitEligibilityPolicyResponse { data }

GET/v1/benefit-eligibility-policies/{policy_id}

Retrieves a benefit eligibility policy by ID.

ParametersExpand Collapse

policy_id: String

Unique benefit eligibility policy identifier (epol_*)

ReturnsExpand Collapse

class BenefitEligibilityPolicyResponse { data }

Response containing a single benefit eligibility policy resource.

data: BenefitEligibilityPolicy { id, active, classification, 4 more }

id: String

active: bool

classification: String

created_at: Time

formatdate-time

employer_id: String

updated_at: Time

formatdate-time

waiting_period: String

Get eligibility policy details

Ruby

HTTP

TypeScript

Python

Ruby

require "vitable_connect"

vitable_connect = VitableConnect::Client.new(
  api_key: "My API Key",
  environment: "environment_1" # defaults to "production"
)

benefit_eligibility_policy_response = vitable_connect.benefit_eligibility_policies.retrieve("epol_abc123def456")

puts(benefit_eligibility_policy_response)

200 example

{
  "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

200 example

{
  "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"
  }
}