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

# List invites

> List the pending invites of the workspace, sorted by email.

Lists the pending invites of the workspace: people who were invited by email and have not joined yet. Use the `email` query parameter to look up a single invite by email; an unknown email returns an empty list.


## OpenAPI

````yaml GET /v1/invites
openapi: 3.1.0
info:
  title: Claap API
  description: Development documentation
  version: 0.0.0
servers:
  - url: https://api.claap.io/
security:
  - ApiKey: []
paths:
  /v1/invites:
    get:
      description: List the pending invites of the workspace, sorted by email.
      operationId: getV1Invites
      parameters:
        - in: query
          name: cursor
          schema:
            type: string
            description: >-
              Paginate the results starting at the cursor returned by a previous
              call. Pages may contain fewer than "limit" results; iterate until
              no nextCursor is returned.
        - in: query
          name: email
          schema:
            type: string
            format: email
            description: >-
              Return only the invite for this email. When provided, cursor and
              limit are ignored. An unknown email returns an empty list.
        - in: query
          name: limit
          schema:
            type: number
            minimum: 1
            maximum: 100
            default: 20
            description: Return at most "limit" results.
      responses:
        '200':
          description: Invites were successfully retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      invites:
                        type: array
                        items:
                          $ref: '#/components/schemas/ApiInvite'
                      pagination:
                        type: object
                        properties:
                          nextCursor:
                            type: string
                    required:
                      - invites
                      - pagination
                required:
                  - result
              example:
                result:
                  invites:
                    - email: jane.doe@example.com
                      role: Member
                      license: Basic
                      invitedAt: '2026-09-01T09:30:00.000Z'
                    - email: john.smith@example.com
                      role: Admin
                      license: Pro
                      invitedAt: '2026-09-02T14:05:00.000Z'
                  pagination: {}
        '400':
          description: Cursor or email is not valid.
components:
  schemas:
    ApiInvite:
      type: object
      properties:
        email:
          type: string
          description: Email the invite was sent to.
        role:
          type: string
          enum:
            - Owner
            - Admin
            - Member
            - Guest
            - None
          description: Role the user will get once they accept the invite.
        license:
          type: string
          enum:
            - None
            - Basic
            - Pro
            - Business
          description: License the user will get once they accept the invite.
        userGroupIds:
          type: array
          items:
            type: string
          description: User groups the user will join once they accept the invite.
        invitedAt:
          type: string
          format: date-time
          description: Date the invite was created.
      required:
        - email
        - role
        - license
        - invitedAt
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: X-Claap-Key

````