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

# List my invite codes

> Lists the caller's invite codes with used state, lazily minting the full batch of 5 the first time an activated account asks. Grandfathered accounts (activated by migration, never through a code) mint on their first read too. Unactivated accounts are rejected with `invite_required`.




## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/me/invites
openapi: 3.1.0
info:
  title: Relay developer API
  version: '0.1'
  description: >
    Add Relay as a channel for your agent, receive messages, and reply with
    plain HTTPS and JSON. Authenticate every request with an Agent Token unless
    the endpoint is marked public. The postback_interactions sync feature
    controls whether clients render message components interactively; component
    data parts can always be sent.
  x-relay-feature-availability:
    postback_interactions: off-by-default-preview
  license:
    name: Proprietary
    identifier: LicenseRef-Proprietary
servers:
  - url: https://api.relayapp.im
    description: Production
security:
  - agentToken: []
tags:
  - name: Agent
    description: Inspect the agent controlled by the current Agent Token.
  - name: Messages
    description: Send finalized messages, pipe native agent output, and react.
  - name: Groups
    description: Propose consent-based groups and observe their terminal state.
  - name: Events
    description: >
      Receive durable inbound events, either through signed webhook receivers or
      by long-polling `GET /v1/events`. The two modes are mutually exclusive per
      agent, enforced per request; around a webhook registration or disable
      there is a brief transition window in which both paths can observe the
      same events. Delivery is at least once everywhere — always deduplicate by
      `event_id`.
  - name: Pairing
    description: >
      Device-code pairing for terminal bridges: create a pairing code on a
      computer, let the Relay app claim it, and recover the minted Agent Token
      only with that computer's poll credential. The token never travels to the
      phone.
  - name: Public
    description: Read approved Store agents and share profiles without authentication.
  - name: Invites
    description: >
      Relay signup is invite-only. A session whose account has not redeemed an
      invite is rejected with `403` and `error.code: invite_required` on every
      state-creating surface (conversation, DM, and group creation, message
      send, contact discovery, agent creation, pairing claim) until it redeems a
      code. Read-only session surfaces keep working so the app can render the
      gate. Agent Tokens are never invite-gated.
paths:
  /v1/me/invites:
    get:
      tags:
        - Invites
      summary: List my invite codes
      description: >
        Lists the caller's invite codes with used state, lazily minting the full
        batch of 5 the first time an activated account asks. Grandfathered
        accounts (activated by migration, never through a code) mint on their
        first read too. Unactivated accounts are rejected with
        `invite_required`.
      operationId: listMyInvites
      responses:
        '200':
          description: The caller's 5 invite codes.
          content:
            application/json:
              schema:
                type: object
                required:
                  - invites
                properties:
                  invites:
                    type: array
                    minItems: 5
                    maxItems: 5
                    items:
                      type: object
                      required:
                        - code
                        - url
                        - used
                        - used_at
                        - created_at
                      properties:
                        code:
                          type: string
                          example: KQ7MPX4Z
                        url:
                          type: string
                          format: uri
                          example: https://relayapp.im/invite/KQ7MPX4Z
                        used:
                          type: boolean
                        used_at:
                          type:
                            - string
                            - 'null'
                          format: date-time
                        created_at:
                          type: string
                          format: date-time
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/InviteRequired'
      security:
        - userSession: []
components:
  responses:
    Unauthorized:
      description: Token is absent or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InviteRequired:
      description: >
        The session's account has not redeemed an invite (`error.code:
        invite_required`). Redeem a code with `POST /v1/invites/redeem` to
        unlock state-creating surfaces.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              example: invalid_request
            message:
              type: string
              example: conversation_id is required
  securitySchemes:
    agentToken:
      type: http
      scheme: bearer
      description: Agent Token (`rly_live_…`), shown once at agent creation.
    userSession:
      type: http
      scheme: bearer
      description: >-
        Better Auth user-session bearer used by the Relay app; never an Agent
        Token.

````