Sign in

v2

latestOpenAPI 3.1.12026-08-0785394779.1 KB
Group Quote Intents

Retrieve the quote for a group quote intent

Retrieves the quote details for a group_quote_intent. Returns pricing information and a fresh PDF URL. Only available when status is quote_available.

get/group_quote_intents/{group_quote_intent_id}/quote

Path parameters

group_quote_intent_idstring required
Example:gqi_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

employee_countinteger required

Number of employees covered by the quote

total_monthly_premiumnumber double required

Total monthly premium for the group

currencystring required

Currency of the premium (e.g. EUR, GBP)

pdf_urlstring nullable

URL to download the quote PDF

pdf_expires_atstring date-time nullable

When the PDF URL expires

generated_atstring date-time required

When the quote was generated

expires_atstring date-time required

When the quote expires

objectstring

Object type identifier

Example response

{
  "employee_count": 123,
  "cost_sharing": {
    "member_count": {
      "adults": 123,
      "children": 123
    },
    "member_selection": {
      "partner": true,
      "children": true
    },
    "percentage": {
      "percentage": 123
    }
  },
  "total_monthly_premium": 123.45,
  "pdf_expires_at": "2024-12-01T00:00:00Z",
  "generated_at": "2024-12-01T00:00:00Z",
  "expires_at": "2024-12-01T00:00:00Z"
}