Skip to main content
GET
Get the employer account

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

Aggregate employer benefits data.

Aggregate and de-identified: never named claims, diagnoses, or any individual health data. Render the employer's plan card from plan; per-employee coverage and payroll deductions are on GET /groups/{groupId}/members.

groupId
string
required
Example:

"grp_8c2f41d09a3e"

asOf
string<date-time>
required
company
object
required
plan
object
required

The plan the employer's employees enrolled in. Once Prescience approves the employer's plan terms (planStatus: approved) every field comes from those terms, the same ones employees see when they enroll. Until then (planStatus: terms_pending) only the plan configuration fields are present, and employeePremiumCents, tiers and employerContribution are null. Render per-tier prices, deductibles and out-of-pocket maximums from tiers.

plans
object[]
required

Every plan offered to the group. One today; plan is always the first entry.

population
object
required

People covered as of today (plan time zone). Before the coverage start date every count is 0; use each member's coverage.status on /members for elected headcount.

funding
object
required
premiums
object
required
spend
object
required

Paid claims only. Patient-uploaded bills and card or cash-pay visits are not included.