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

# List rewards



## OpenAPI

````yaml get /v1/rewards
openapi: 3.1.0
info:
  title: One of None API
  version: 1.0.0
  description: >-
    The One of None API manages product collections, registrations, short URLs,
    team operations, and rewards used by storefront integrations including
    Shopify discounts and redemption flows.
servers:
  - url: https://api.oneofnone.io
security:
  - ApiKeyAuth: []
paths:
  /v1/rewards:
    get:
      summary: List rewards
      parameters:
        - schema:
            anyOf:
              - type: string
                enum:
                  - draft
                  - active
                  - paused
                  - expired
                  - archived
              - type: array
                items:
                  type: string
                  enum:
                    - draft
                    - active
                    - paused
                    - expired
                    - archived
                minItems: 1
          required: false
          name: status
          in: query
        - schema:
            type: string
            enum:
              - DISCOUNT
              - GATED_CONTENT
              - FREE_CLAIM
              - EARLY_ACCESS
              - CREDIT
          required: false
          name: type
          in: query
        - schema:
            type: string
            enum:
              - sitewide
              - collection
              - product
              - variant
          required: false
          name: scope
          in: query
        - schema:
            type: number
            minimum: 1
            maximum: 1000
          required: false
          name: limit
          in: query
        - schema:
            type: number
          required: false
          name: offset
          in: query
        - schema:
            type: string
            enum:
              - asc
              - desc
          required: false
          name: order
          in: query
        - schema:
            type: string
          required: false
          name: order_by
          in: query
        - schema:
            type: boolean
          required: false
          name: include_count
          in: query
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RewardListResponse'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    RewardListResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Reward'
        pagination:
          type: object
          properties: {}
          additionalProperties: {}
      required:
        - data
        - pagination
    Reward:
      type: object
      properties:
        id:
          type: string
          format: uuid
        teamId:
          type: string
          format: uuid
        name:
          type: string
        description:
          type:
            - string
            - 'null'
        type:
          type: string
          enum:
            - DISCOUNT
            - GATED_CONTENT
            - FREE_CLAIM
            - EARLY_ACCESS
            - CREDIT
        scope:
          type: string
          enum:
            - sitewide
            - collection
            - product
            - variant
        valueType:
          type: string
          enum:
            - percentage
            - fixed_amount
            - free_shipping
        value:
          type: integer
        minimumPurchase:
          type:
            - integer
            - 'null'
        minimumQuantity:
          type:
            - integer
            - 'null'
        usageLimitTotal:
          type:
            - integer
            - 'null'
        usageLimitPerCustomer:
          type:
            - integer
            - 'null'
        startsAt:
          type: string
        expiresAt:
          type:
            - string
            - 'null'
        stackable:
          type: boolean
        codeType:
          type: string
          enum:
            - automatic
            - global_code
            - unique_codes
        globalCode:
          type:
            - string
            - 'null'
        externalUrl:
          type:
            - string
            - 'null'
        imageId:
          type:
            - integer
            - 'null'
        image:
          type:
            - object
            - 'null'
          properties:
            id:
              type: integer
            url:
              type:
                - string
                - 'null'
          required:
            - id
            - url
        conditions:
          type: object
          additionalProperties: {}
        status:
          type: string
          enum:
            - draft
            - active
            - paused
            - expired
            - archived
        totalRedemptions:
          type: integer
        totalRevenueImpact:
          type: number
        createdAt:
          type: string
        updatedAt:
          type:
            - string
            - 'null'
        externalIds:
          type: array
          items:
            $ref: '#/components/schemas/RewardExternalId'
        access:
          $ref: '#/components/schemas/RewardAccessSummary'
      required:
        - id
        - teamId
        - name
        - description
        - type
        - scope
        - valueType
        - value
        - minimumPurchase
        - minimumQuantity
        - usageLimitTotal
        - usageLimitPerCustomer
        - startsAt
        - expiresAt
        - stackable
        - codeType
        - globalCode
        - externalUrl
        - imageId
        - conditions
        - status
        - totalRedemptions
        - totalRevenueImpact
        - createdAt
        - updatedAt
      additionalProperties: false
    RewardExternalId:
      type: object
      properties:
        id:
          type: string
          format: uuid
        rewardId:
          type: string
          format: uuid
        system:
          type: string
          enum:
            - shopify
            - stripe
        externalId:
          type: string
        externalCodeId:
          type:
            - string
            - 'null'
        syncedAt:
          type: string
        syncStatus:
          type: string
          enum:
            - synced
            - pending
            - error
        error:
          type:
            - string
            - 'null'
        createdAt:
          type: string
        updatedAt:
          type:
            - string
            - 'null'
      required:
        - id
        - rewardId
        - system
        - externalId
        - externalCodeId
        - syncedAt
        - syncStatus
        - error
        - createdAt
        - updatedAt
      additionalProperties: false
    RewardAccessSummary:
      type: object
      properties:
        qualifies:
          type: boolean
        reasons:
          type: array
          items:
            type: string
      required:
        - qualifies
        - reasons
      additionalProperties: false
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````