> ## Documentation Index
> Fetch the complete documentation index at: https://omniflow-vpn.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Get v1accountreferrals

> The customer's code, its shareable link, the program's terms, and the reward history. A reversed reward is excluded from the earned total and from the cap count, because an operator reverses one when the referral turns out to be abuse and the slot it consumed should come back.



## OpenAPI

````yaml https://raw.githubusercontent.com/kewldan/omniflow/main/api/openapi.yaml get /v1/account/referrals
openapi: 3.0.3
info:
  title: Omniflow API
  version: 1.0.0
  description: >-
    Customer, commerce, payment, wallet, fulfillment, and operations API for
    Omniflow.
servers: []
security: []
paths:
  /v1/account/referrals:
    get:
      tags:
        - account
      description: >-
        The customer's code, its shareable link, the program's terms, and the
        reward history. A reversed reward is excluded from the earned total and
        from the cap count, because an operator reverses one when the referral
        turns out to be abuse and the slot it consumed should come back.
      operationId: getAccountReferrals
      parameters:
        - $ref: '#/components/parameters/Cursor'
        - in: query
          name: limit
          schema:
            type: integer
            minimum: 1
            maximum: 100
      responses:
        '200':
          description: Referrals
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountReferrals'
components:
  parameters:
    Cursor:
      in: query
      name: cursor
      schema:
        type: string
        description: Opaque keyset cursor from the previous page.
  schemas:
    AccountReferrals:
      type: object
      required:
        - program
        - code
        - link
        - linkAvailable
        - invited
        - qualified
        - pending
        - rejected
        - rewardedMinor
        - reversedMinor
        - rewardCount
        - currency
        - rewards
      properties:
        program:
          type: object
          required:
            - enabled
            - currency
            - inviterRewardMinor
            - inviteeRewardMinor
            - qualification
          properties:
            enabled:
              type: boolean
            currency:
              type: string
            inviterRewardMinor:
              type: integer
              format: int64
            inviteeRewardMinor:
              type: integer
              format: int64
            qualification:
              type: string
            attributionValidityDays:
              type: integer
            inviterRewardCap:
              type: integer
              nullable: true
            rewardExpiryDays:
              type: integer
              nullable: true
            termsUrl:
              type: string
        code:
          type: string
        link:
          type: string
        linkAvailable:
          type: boolean
        linkReason:
          type: string
          enum:
            - public_url_not_configured
            - no_code
          description: >-
            Why no link could be built. The code is still shown; a link to
            nowhere is not.
        invited:
          type: integer
          format: int64
        qualified:
          type: integer
          format: int64
        pending:
          type: integer
          format: int64
        rejected:
          type: integer
          format: int64
        rewardedMinor:
          type: integer
          format: int64
          description: Excludes reversed rewards.
        reversedMinor:
          type: integer
          format: int64
        rewardCount:
          type: integer
        currency:
          type: string
        remainingSlots:
          type: integer
          nullable: true
        rewards:
          type: object
          required:
            - items
          properties:
            items:
              type: array
              items:
                type: object
                required:
                  - id
                  - role
                  - state
                  - amountMinor
                  - currency
                  - grantedAt
                properties:
                  id:
                    type: string
                    format: uuid
                  role:
                    type: string
                    enum:
                      - inviter
                      - invitee
                  state:
                    type: string
                    enum:
                      - pending
                      - qualified
                      - rejected
                  amountMinor:
                    type: integer
                    format: int64
                  currency:
                    type: string
                  grantedAt:
                    type: string
                    format: date-time
                  reversedAt:
                    type: string
                    format: date-time
            nextCursor:
              type: string

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.