Get eligibility policy details

get/v1/benefit-eligibility-policy/{policy_id}

Retrieves detailed information for a specific benefit eligibility policy by ID. Returns the complete policy configuration including all eligibility rules, effective dates, associated employer information, and any waiting period requirements.

Path ParametersExpand Collapse

policy_id: string

ReturnsExpand Collapse

BenefitEligibilityPolicy = object { id, active, created_at, 7 more }

Serializer for Benefit Eligibility Policy entity.

Eligibility policies define rules that determine which employees qualify for benefits.

id: string

Unique eligibility policy identifier with 'epol_' prefix

active: boolean

Whether this policy is currently active

created_at: string

Timestamp when the policy was created

formatdate-time

effective_date: string

Date when this policy becomes effective

formatdate

employer_id: string

ID of the employer this policy belongs to (empr_*)

name: string

Display name for the eligibility policy

rules: array of object { operator, rule_type, value }

List of eligibility rules that must be satisfied

operator: string

Comparison operator (e.g., 'equals', 'greater_than', 'in')

rule_type: string

Type of eligibility rule (e.g., 'employment_status', 'hours_per_week', 'waiting_period')

value: unknown

Value to compare against (type depends on rule_type)

updated_at: string

Timestamp when the policy was last updated

formatdate-time

description: optional string

Detailed description of the policy

replaced_policy_id: optional string

ID of the policy this one replaces, if any (epol_*)

Get eligibility policy details

curl https://api.vitablehealth.com/v1/benefit-eligibility-policy/$POLICY_ID \
    -H "Authorization: Bearer $VITABLE_connect_API_API_KEY"

{
  "id": "id",
  "active": true,
  "created_at": "2019-12-27T18:11:19.117Z",
  "effective_date": "2019-12-27",
  "employer_id": "employer_id",
  "name": "name",
  "rules": [
    {
      "operator": "operator",
      "rule_type": "rule_type",
      "value": {}
    }
  ],
  "updated_at": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "replaced_policy_id": "replaced_policy_id"
}

Returns Examples

{
  "id": "id",
  "active": true,
  "created_at": "2019-12-27T18:11:19.117Z",
  "effective_date": "2019-12-27",
  "employer_id": "employer_id",
  "name": "name",
  "rules": [
    {
      "operator": "operator",
      "rule_type": "rule_type",
      "value": {}
    }
  ],
  "updated_at": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "replaced_policy_id": "replaced_policy_id"
}