> ## Documentation Index
> Fetch the complete documentation index at: https://getprescience.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List groups

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



## OpenAPI

````yaml /api-reference/openapi.json get /groups
openapi: 3.1.0
info:
  title: Prescience Partner API
  version: 1.1.0
  description: >-
    Create employer groups, submit census records, generate indicative quotes,
    create enrollments, and read aggregate account data.


    Money is always integer cents. Dates are `YYYY-MM-DD`; timestamps are ISO
    8601 UTC. Quotes are indicative pending underwriting confirmation. A BAA and
    data processing agreement are executed before live mode is enabled.
  contact:
    name: Prescience partner engineering
    email: partners@getprescience.com
servers:
  - url: https://www.getprescience.com/api/partner/v1
    description: >-
      Production. Test and live traffic share this host; mode comes from your
      API key.
security:
  - bearerAuth: []
tags:
  - name: Health
    description: Connectivity and key checks.
  - name: Plans
    description: Static plan metadata.
  - name: Groups
    description: 'Employer groups: the root resource of every integration.'
  - name: Census
    description: Pre-enrollment census intake and ongoing member sync.
  - name: Quotes
    description: Deterministic, synchronous quotes. Indicative pending underwriting.
  - name: Enrollments
    description: Plan selection and employer provisioning.
  - name: Account
    description: Aggregate, de-identified employer account data.
  - name: Webhooks
    description: Signed event delivery (standard-webhooks scheme).
paths:
  /groups:
    get:
      tags:
        - Groups
      summary: List groups
      description: All groups created by your keys in the current mode, newest first.
      operationId: listGroups
      parameters:
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/Cursor'
      responses:
        '200':
          description: A page of groups.
          content:
            application/json:
              schema:
                type: object
                required:
                  - groups
                properties:
                  groups:
                    type: array
                    items:
                      $ref: '#/components/schemas/Group'
                  nextCursor:
                    type:
                      - string
                      - 'null'
                    description: >-
                      Pass as `?cursor=` for the next page. `null` on the last
                      page.
              example:
                groups:
                  - id: grp_8c2f41d09a3e
                    mode: test
                    status: quoted
                    companyName: Acme Inc
                    domain: acme.com
                    externalId: co_4821
                    address:
                      line1: 548 Market St
                      city: San Francisco
                      state: CA
                      zip: '94104'
                    contact:
                      name: Dana Park
                      email: dana@acme.com
                      title: Head of People
                    currentCoverage:
                      planType: fully_insured
                      carrier: Anthem
                      pepmCents: 80000
                      renewalDate: '2026-09-01'
                    censusMemberCount: 12
                    companyState: null
                    createdAt: '2026-06-10T17:04:11Z'
                    updatedAt: '2026-06-10T17:22:05Z'
                nextCursor: null
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  parameters:
    Limit:
      name: limit
      in: query
      required: false
      description: Page size. Default 50, max 200.
      schema:
        type: integer
        minimum: 1
        maximum: 200
        default: 50
    Cursor:
      name: cursor
      in: query
      required: false
      description: >-
        Opaque cursor from a previous page's `nextCursor`. Lists are
        newest-first.
      schema:
        type: string
  schemas:
    Group:
      type: object
      required:
        - id
        - mode
        - status
        - companyName
        - domain
        - censusMemberCount
        - createdAt
        - updatedAt
      properties:
        id:
          type: string
          example: grp_8c2f41d09a3e
        mode:
          type: string
          enum:
            - test
            - live
        status:
          type: string
          enum:
            - created
            - census_received
            - quoted
            - enrolled
            - active
          description: >-
            Lifecycle: `created` -> `census_received` -> `quoted` -> `enrolled`
            -> `active` (active = company flipped to prod by Prescience).
        companyName:
          type: string
          example: Acme Inc
        domain:
          type: string
          example: acme.com
        externalId:
          type:
            - string
            - 'null'
          description: Your internal employer ID.
          example: co_4821
        address:
          $ref: '#/components/schemas/Address'
        contact:
          $ref: '#/components/schemas/Contact'
        currentCoverage:
          $ref: '#/components/schemas/CurrentCoverage'
        censusMemberCount:
          type: integer
          example: 12
        companyState:
          type:
            - string
            - 'null'
          enum:
            - sandbox
            - prod
            - null
          description: >-
            `null` until enrolled, then `sandbox`, then `prod` once Prescience
            activates the group.
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    Address:
      type: object
      properties:
        line1:
          type: string
          example: 548 Market St
        city:
          type: string
          example: San Francisco
        state:
          type: string
          example: CA
        zip:
          type: string
          example: '94104'
    Contact:
      type: object
      properties:
        name:
          type: string
          example: Dana Park
        email:
          type: string
          format: email
          example: dana@acme.com
        title:
          type: string
          example: Head of People
    CurrentCoverage:
      type: object
      description: >-
        The employer's coverage today. `pepmCents` is used as the savings
        baseline when quoting unless overridden per-quote.
      properties:
        planType:
          type: string
          enum:
            - fully_insured
            - peo
            - ichra
            - level_funded
            - none
          example: fully_insured
        carrier:
          type: string
          example: Anthem
        pepmCents:
          type: integer
          description: Current all-in cost per employee per month, in cents.
          example: 80000
        renewalDate:
          type: string
          format: date
          example: '2026-09-01'
    Error:
      type: object
      required:
        - error
        - message
      properties:
        error:
          type: string
          enum:
            - unauthorized
            - live_mode_disabled
            - forbidden
            - not_found
            - invalid_request
            - conflict
            - quote_expired
            - census_required
            - rate_limited
            - server_error
            - not_configured
          description: Stable machine-readable error code.
        message:
          type: string
          description: >-
            Human-readable explanation. Wording may change; branch on `error`,
            not `message`.
        details:
          type: array
          description: Present on `invalid_request`. One entry per failed field.
          items:
            type: object
            required:
              - field
              - message
            properties:
              field:
                type: string
                example: zip
              message:
                type: string
                example: zip must be a 5-digit ZIP code
              index:
                type: integer
                description: >-
                  For array payloads (census rows), the zero-based index of the
                  failing row.
                example: 7
  responses:
    Unauthorized:
      description: Missing, malformed, or revoked API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: unauthorized
            message: >-
              Provide a valid partner API key as `Authorization: Bearer
              psk_...`.
    RateLimited:
      description: Rate limit exceeded. Honor `Retry-After`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: rate_limited
            message: Rate limit exceeded. Retry after 12 seconds.
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
          example: 12
    ServerError:
      description: >-
        Something failed on our side. Safe to retry with the same
        `Idempotency-Key`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: server_error
            message: Internal error. The request was not applied.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Partner API key. `psk_test_<32 hex>` for test mode, `psk_live_<32 hex>`
        for live mode. Keys are stored hashed and cannot be recovered; store
        them in your secrets manager on issue.

````