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

Get eligibility policy details

client.benefitEligibilityPolicies.retrieve(stringpolicyID, RequestOptionsoptions?): BenefitEligibilityPolicyResponse { data }
GET/v1/benefit-eligibility-policies/{policy_id}

Retrieves a benefit eligibility policy by ID.

ParametersExpand Collapse
policyID: string

Unique benefit eligibility policy identifier (epol_*)

ReturnsExpand Collapse
BenefitEligibilityPolicyResponse { data }

Response containing a single benefit eligibility policy resource.

data: BenefitEligibilityPolicy { id, active, classification, 4 more }
id: string
active: boolean
classification: string
created_at: string
formatdate-time
employer_id: string
updated_at: string
formatdate-time
waiting_period: string

Get eligibility policy details

import VitableConnect from '@vitable-inc/vitable-connect';

const client = new VitableConnect({
  apiKey: process.env['VITABLE_CONNECT_API_KEY'], // This is the default and can be omitted
});

const benefitEligibilityPolicyResponse = await client.benefitEligibilityPolicies.retrieve(
  'epol_abc123def456',
);

console.log(benefitEligibilityPolicyResponse.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"
  }
}