v2

latestOpenAPI 3.1.12026-08-0785394779.1 KB

Health Insurance

Retrieve employer quote

Returns group's health insurance quote for an employer by employer_quote_id.

get/employers/{employer_id}/health_insurance/quotes/{employer_quote_id}

Path parameters

employer_idstring required

Example:er_3b1333d87d9d4fd6ad83ba7f6b0e951a

employer_quote_idstring required

Example:erhq_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

objectstring

The object type

idstring required

Unique identifier for the quote

employer_idstring required

The Id of the employer for which the is created

quoted_atstring date-time required

Date and time the quote was created at

status'pending_quote' | 'action_required' | 'not_undertaken' | 'accepted' | 'pending_insurer_acceptance' required

Example response

{
  "id": "erhq_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "employer_id": "er_3b1333d87d9d4fd6ad83ba7f6b0e951a",
  "quoted_at": "2024-12-01T00:00:00Z",
  "required_action": {
    "due_at": "2024-12-01"
  },
  "coverage_levels": [
    {
      "plan_id": "pl_3b1333d87d9d4fd6ad83ba7f6b0e951a"
    }
  ]
}