Skip to main content
GET
Get the employee benefits summary

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

Approved benefits summary.

groupId
string
revision
integer

Approved plan-terms revision. Regenerate offer letters when it changes.

approvedAt
string<date-time>
plan
object
employeeMonthlyContributionCents
object
dentalVisionMonthlyContributionCents
object
deductibleCents
object
outOfPocketMaximumCents
object
coinsurancePercent
number | null
services
object[]
disclosures
string[]

Print these wherever the summary appears.