Get eligibility policy details

benefit_eligibility_policy.retrieve(policy_id) -> BenefitEligibilityPolicyAPI { id, active, created_at, 7 more }

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.

ParametersExpand Collapse

policy_id: String

ReturnsExpand Collapse

class BenefitEligibilityPolicyAPI { 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: bool

Whether this policy is currently active

created_at: Time

Timestamp when the policy was created

formatdate-time

effective_date: Date

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[{ 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: untyped

Value to compare against (type depends on rule_type)

updated_at: Time

Timestamp when the policy was last updated

formatdate-time

description: String

Detailed description of the policy

replaced_policy_id: String

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

Get eligibility policy details

require "vitable_connect_api"

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

benefit_eligibility_policy = vitable_connect_api.benefit_eligibility_policy.retrieve("epol_abc123def456")

puts(benefit_eligibility_policy)

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