Skip to main content
GET
Get a group

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

Response

The group.

A group as a broker reads it with GET /groups and GET /groups/{groupId}: the group, and what a broker adds to it.

id
string
required
Example:

"grp_8c2f41d09a3e"

mode
enum<string>
required
Available options:
test,
live
status
enum<string>
required

Lifecycle: created -> census_received -> quoted -> enrolled -> active (active = company flipped to prod by Prescience).

Available options:
created,
census_received,
quoted,
enrolled,
active
company_name
string
required
Example:

"Acme Inc"

domain
string
required
Example:

"acme.com"

market_plans
integer
required

Always 0: plans sent in market_plans are no longer used.

Example:

0

census_member_count
integer
required
Example:

12

created_at
string<date-time>
required
updated_at
string<date-time>
required
rating_zip
string | null
required

The headquarters ZIP the group is priced from.

Example:

"94110"

pricing
string | null
required

Where pricing stands: done once rates are in, failed if pricing failed. null before the first pricing run.

Example:

"done"

enrolled
boolean
required

true once the group is enrolled.

benefits_admin
enum<string>
required

Who runs benefits administration for your account.

Available options:
prescience,
partner
latest_quote
object | null
required

The group's latest quote, or null before the first one.

Registered legal name, when you sent one.

external_id
string | null

Your internal employer ID.

Example:

"co_4821"

address
object | null
contact
object | null
current_coverage
object | null

Optional historical coverage metadata. It is not required for market-rate quotes.

plan_design
object

Present once you have set any plan design field.

move_forward
object

Present once the client's move-forward request was recorded with POST /groups/{groupId}/move-forward.

enrollment
object

Present once the client's move-forward request was recorded: the carrier and plan to submit for enrollment, and where enrollment stands.

company_state
enum<string> | null

null until enrolled, then sandbox, then prod once Prescience activates the group.

Available options:
sandbox,
prod,
null