---
title: "List groups"
method: GET
path: "/groups"
tags: ["Groups"]
---

# List groups

`GET /groups`

All groups created by your keys in the current mode, newest first.

## Query parameters

- `limit` integer
- `cursor` string

## Response `200`

A page of groups.

- object
  - `groups` Group[], required
    - `id` string, required
    - `mode` 'test' | 'live', required
    - `status` 'created' | 'census_received' | 'quoted' | 'enrolled' | 'active', required — Lifecycle: `created` -> `census_received` -> `quoted` -> `enrolled` -> `active` (active = company flipped to prod by Prescience).
    - `companyName` string, required
    - `domain` string, required
    - `externalId` string, nullable — Your internal employer ID.
    - `address` Address
      - `line1` string
      - `city` string
      - `state` string
      - `zip` string
    - `contact` Contact
      - `name` string
      - `email` string, email
      - `title` string
    - `currentCoverage` CurrentCoverage — The employer's coverage today. `pepmCents` is used as the savings baseline when quoting unless overridden per-quote.
      - `planType` 'fully_insured' | 'peo' | 'ichra' | 'level_funded' | 'none'
      - `carrier` string
      - `pepmCents` integer — Current all-in cost per employee per month, in cents.
      - `renewalDate` string, date
    - `censusMemberCount` integer, required
    - `companyState` 'sandbox' | 'prod' | 'null', nullable — `null` until enrolled, then `sandbox`, then `prod` once Prescience activates the group.
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
  - `nextCursor` string, nullable — Pass as `?cursor=` for the next page. `null` on the last page.

## Other responses

- `401` — Missing, malformed, or revoked API key.
- `429` — Rate limit exceeded. Honor `Retry-After`.
- `500` — Something failed on our side. Safe to retry with the same `Idempotency-Key`.

---

[API](https://skmtc.dev/getprescience/apis/prescience-partner-api.md) · [All operations](https://skmtc.dev/getprescience/apis/prescience-partner-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/getprescience/prescience-partner-api/revisions/eb1f377f8139/schema)