v1

latestOpenAPI 3.1.02026-07-22191956.7 KB
Account

Get the employer account

Aggregate employer account data: funding, premium-equivalent totals, spend by category, and savings. Account data is aggregate and de-identified by design. Returns 404 not_found until the group is enrolled.

get/groups/{groupId}/account

Path parameters

groupIdstring required

Group ID, e.g. grp_8c2f41d09a3e.

Response

Aggregate employer benefits data.

groupIdstring required
asOfstring date-time required

Example response

{
  "groupId": "grp_8c2f41d09a3e",
  "company": {
    "displayName": "Acme Inc"
  },
  "plan": {
    "name": "Prescience Diamond",
    "deductibleIndividualCents": 150000,
    "deductibleFamilyCents": 300000,
    "oopMaxIndividualCents": 705000,
    "oopMaxFamilyCents": 1410000
  },
  "funding": {
    "upcomingPulls": [
      {
        "status": "scheduled"
      }
    ],
    "recentPulls": [
      {
        "status": "scheduled"
      }
    ]
  },
  "spend": {
    "suppressionNote": "Spend categories are hidden for small groups to protect member privacy."
  }
}
All 19 operations