Sign in

v2

latestOpenAPI 3.1.12026-08-0785394779.1 KB
Health Insurance

Retrieve an employer policy

Retrieve group's health insurance policy for an employer by employer_policy_id.

get/employers/{employer_id}/health_insurance/policies/{employer_policy_id}

Path parameters

employer_idstring required
Example:er_3b1333d87d9d4fd6ad83ba7f6b0e951a
employer_policy_idstring required
Example:erhp_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

objectstring

The object type

idstring required

Unique identifier for policy

employer_idstring required

The Id of the employer for which the policy is created

start_datestring date required

Policy starts on this date

end_datestring date required

Policy ends on this date

cancellation_datestring date nullable

Policy was cancelled on this date, if cancellation occured

group_policy_numberstring nullable

Group’s health insurance policy number, if available

status'scheduled' | 'active' | 'expired' | 'cancelled' required
enrolment_type'opt_out' | 'opt_in' required
employer_cancellation_period_lengthinteger required

How many days the employer has to cancel the policy since the policy starts

Example response

{
  "id": "erhp_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "employer_id": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "start_date": "2024-12-01",
  "end_date": "2024-12-01",
  "cancellation_date": "2024-12-01",
  "renewal": {
    "renewal_date": "2024-12-01",
    "window_start_date": "2024-12-01",
    "window_end_date": "2024-12-01",
    "decision_confirmed": true,
    "renewed_health_insurance_id": "erhp_3b1333d87d9d4fd6ad83ba7f6b0e951a"
  },
  "employer_cancellation_period_length": 123,
  "coverage_levels": [
    {
      "plan_id": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a"
    }
  ]
}