Sign in

v2

latestOpenAPI 3.1.12026-08-0785394779.1 KB
Policies

Retrieve a policy

Retrieves a policy object.

get/policies/{policy_id}

Path parameters

policy_idstring required
Example:p_3b1333d87d9d4fd6ad83ba7f6b0e951a

Headers

X-Platform-Idstring

The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.

Response

OK

idstring required

Unique identifier for the policy. Prefixed with p_.

employee_idstring required

Identifier of the employee associated with this policy. Prefixed with ee_.

group_policy_idstring required

Identifier of the group policy id associated with this policy. Prefixed with gp_.

bundling_type'not_bundled' | 'bundled_primary' | 'bundled_secondary' required
status'scheduled' | 'active' | 'expired' | 'cancelled' required
group_idstring required

Identifier of the group associated with this policy. Prefixed with gr_.

start_datestring date required

Policy start (effective) date in ISO 8601 (YYYY-MM-DD)

end_datestring date nullable

Policy end date (inclusive) in ISO 8601, or null if open-ended

cancellation_datestring date nullable

Date the policy was cancelled (if applicable)

type'health_insurance' | 'life_assurance' required
objectstring

Object type

Example response

{
  "id": "p_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "employee_id": "ee_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "group_policy_id": "gp_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "group_id": "gr_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "provider": {
    "id": "pr_3b1333d87d9d4fd6ad83ba7f6b0e951a"
  },
  "plan": {
    "id": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a"
  },
  "start_date": "2024-12-01",
  "end_date": "2024-12-01",
  "cancellation_date": "2024-12-01",
  "health_insurance": {
    "opt_out_deadline": "2024-12-01",
    "initial_dependents_update_deadline": "2024-12-01",
    "renewal": {
      "renewal_date": "2024-12-01",
      "window_start_date": "2024-12-01",
      "window_end_date": "2024-12-01",
      "renewed_policy_id": "p_3b1333d87d9d4fd6ad83ba7f6b0e951a"
    },
    "dependents_supported": true,
    "configuration": {
      "cost_sharing": {
        "member_count": {
          "adults": 123,
          "children": 123
        },
        "member_selection": {
          "partner": true,
          "children": true
        },
        "percentage": {
          "percentage": 123
        }
      }
    },
    "members": [
      {
        "id": "pm_3b1333d87d9d4fd6ad83ba7f6b0e951a",
        "date_of_birth": "2024-12-01",
        "associated_person_id": "ap_3b1333d87d9d4fd6ad83ba7f6b0e951a"
      }
    ],
    "estimated_gross_premium": {
      "monthly": {
        "employee_contribution": 123.45,
        "employer_contribution": 123.45,
        "total": 123.45
      },
      "term": {
        "employee_contribution": 123.45,
        "employer_contribution": 123.45,
        "total": 123.45
      }
    }
  }
}