Skip to main content
GET
List quotes

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}$

Query Parameters

limit
integer
default:50

Page size. Default 50, max 200.

Required range: 1 <= x <= 200
cursor
string

Opaque cursor from a previous page's nextCursor. Lists are newest-first.

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

A page of quotes.

quotes
object[]
required
count
integer
required

Quotes on this page.

next_cursor
string | null