Skip to main content
GET
Get a quote

Authorizations

Authorization
string
header
required

Partner API key. psk_test_<32 hex> for test mode, psk_live_<32 hex> for live mode. Store them in your secrets manager on issue. Live keys are shown once; the scoped partner portal can show an active sandbox key again.

Path Parameters

groupId
string
required

Group ID, e.g. grp_8c2f41d09a3e.

Pattern: ^grp_[0-9a-f]{12}$
quoteId
string
required

Quote ID, e.g. qt_5b9e2c7f10ad.

Pattern: ^qt_[0-9a-f]{12}$

Query Parameters

view
enum<string>

Broker keys only. numbers (the default) returns each plan's prices, deductible, out-of-pocket maximum and the most extra the company pays. full adds what each plan is: description, benefits, logos. Other partners always get the whole quote.

Available options:
numbers,
full
fields
string

Comma-separated fields to return, e.g. plans.pmpm_cents. Reach into the plans with plans.<field>. quote_id, group_id and status are always returned. Also accepted as fields in a POST body.

exclude
string

Comma-separated fields to leave out, e.g. plans.logos. Logo URLs do not change, so fetch them once, cache them and exclude them after. Also accepted as exclude in a POST body.

Response

The quote.

The quote as a broker gets it: numbers only by default, and what each plan is with view=full.

quote_id
string
required
group_id
string
required
status
enum<string>
required
Available options:
ready,
in_review,
expired
plans
object[]
required
materials
object[]

Quote-specific sales previews for employees and employers. Forwardable links include an interactive view and PDF. Pending group links become available when pricing completes; a changed census requires a new quote. Preview terms are subject to underwriting and enrollment. Links are omitted when signing is unavailable.

expires_at
string<date-time>
plan_year_start_date
string<date>
census
object
ignored_plans
object[]

Plans you sent that were skipped, and why.