> ## 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 enrolled members

> Enrollment-admin data for the benefits tab roster: who is invited, who has created an account, and COBRA status. Returns `404 not_found` until the group is enrolled; use `GET /groups/{groupId}/census` before that. No health data, ever.



## OpenAPI

````yaml /api-reference/openapi.json get /groups/{groupId}/members
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/{groupId}/members:
    get:
      tags:
        - Account
      summary: List enrolled members
      description: >-
        Enrollment-admin data for the benefits tab roster: who is invited, who
        has created an account, and COBRA status. Returns `404 not_found` until
        the group is enrolled; use `GET /groups/{groupId}/census` before that.
        No health data, ever.
      operationId: listEnrolledMembers
      parameters:
        - $ref: '#/components/parameters/GroupId'
      responses:
        '200':
          description: Enrolled members.
          content:
            application/json:
              schema:
                type: object
                required:
                  - members
                  - count
                properties:
                  members:
                    type: array
                    items:
                      $ref: '#/components/schemas/EnrolledMember'
                  count:
                    type: integer
                    description: Total members in the roster.
              example:
                members:
                  - memberId: mem_c4a91f27e83d
                    externalId: emp_0001
                    firstName: Jordan
                    lastName: Reyes
                    email: jordan@acme.com
                    status: active
                    employmentType: full_time
                    hireDate: '2024-03-01'
                    dependents: 0
                    enrollment:
                      invited: true
                      accountCreated: true
                  - memberId: mem_f7b3d59e02a4
                    externalId: emp_0008
                    firstName: Grace
                    lastName: Okafor
                    email: grace@acme.com
                    status: active
                    employmentType: full_time
                    hireDate: '2023-07-15'
                    dependents: 1
                    enrollment:
                      invited: true
                      accountCreated: false
                  - memberId: mem_92e4b7a1d0c6
                    externalId: emp_0009
                    firstName: Tom
                    lastName: Becker
                    email: tom@acme.com
                    status: cobra
                    employmentType: full_time
                    hireDate: '2022-01-10'
                    dependents: 1
                    enrollment:
                      invited: true
                      accountCreated: true
                    cobra:
                      until: '2028-05-31'
                count: 12
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: >-
            Group not found, or not enrolled yet (members are available
            post-enrollment).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: not_found
                message: >-
                  Group grp_8c2f41d09a3e is not enrolled. Use GET
                  /groups/{groupId}/census before enrollment.
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  parameters:
    GroupId:
      name: groupId
      in: path
      required: true
      description: Group ID, e.g. `grp_8c2f41d09a3e`.
      schema:
        type: string
        pattern: ^grp_[0-9a-f]{12}$
      example: grp_8c2f41d09a3e
  schemas:
    EnrolledMember:
      type: object
      required:
        - memberId
        - firstName
        - lastName
        - email
        - status
        - dependents
        - enrollment
      properties:
        memberId:
          type: string
          example: mem_c4a91f27e83d
        externalId:
          type: string
          example: emp_0001
        firstName:
          type: string
          example: Jordan
        lastName:
          type: string
          example: Reyes
        email:
          type: string
          format: email
          example: jordan@acme.com
        status:
          type: string
          enum:
            - active
            - terminated
            - cobra
        employmentType:
          type: string
          enum:
            - full_time
            - part_time
            - contractor
        hireDate:
          type: string
          format: date
        dependents:
          type: integer
          description: Count only; dependent details are not exposed post-enrollment.
          example: 0
        enrollment:
          type: object
          properties:
            invited:
              type: boolean
            accountCreated:
              type: boolean
        cobra:
          type: object
          description: Present when `status` is `cobra`.
          properties:
            until:
              type: string
              format: date
              example: '2028-05-31'
    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.

````