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

# Get apiv1userinvite codes



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/user/invite-codes
openapi: 3.1.0
info:
  title: ekiden-gateway
  description: >-
    API Gateway and WebSocket proxy based on Axum and Utoipa, handling auth,
    rate limiting, and connection buffering.
  license:
    name: ''
  version: 0.1.1
servers:
  - url: https://api.ekiden.fi/
    description: Production
  - url: https://api.cnt.ekiden.fi/
    description: Testnet
  - url: https://api.canton.ekiden.fi/
    description: Staging
security: []
paths:
  /api/v1/user/invite-codes:
    get:
      tags:
        - User
      operationId: get_user_invite_codes
      responses:
        '200':
          description: Earned invite-code standing
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InviteCodesResponse'
      security:
        - bearer_auth: []
components:
  schemas:
    InviteCodesResponse:
      type: object
      required:
        - volumeUsdc
        - earned
        - claimed
        - available
        - cap
        - gatingEnabled
        - codes
      properties:
        available:
          type: integer
          format: int64
          minimum: 0
        cap:
          type: integer
          format: int64
          minimum: 0
        claimed:
          type: integer
          format: int64
          minimum: 0
        codes:
          type: array
          items:
            $ref: '#/components/schemas/InviteCodeEntry'
        earned:
          type: integer
          format: int64
          minimum: 0
        gatingEnabled:
          type: boolean
          description: Root-whitelist enforcement. When false, invite codes are unused.
        volumeUsdc:
          type: string
    InviteCodeEntry:
      type: object
      required:
        - code
        - status
        - createdAtMs
      properties:
        code:
          type: string
        createdAtMs:
          type: integer
          format: int64
        redeemedBy:
          type:
            - string
            - 'null'
        status:
          type: string
          description: '`active` or `used`.'
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer

````