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

# List voucher redemptions

> Returns only resources owned by the organization encoded in the tenant API key.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/vouchers/redemptions
openapi: 3.1.0
info:
  title: Nautilus Public API
  version: 1.0.0
  description: >-
    Tenant-scoped public API. Except for /api/v1/openapi.json, requests use a
    Clerk tenant API key as a Bearer token. The key's organizationId is the sole
    tenant scope; organization IDs supplied by callers are never accepted.
    Detail endpoints deliberately return 404 for both missing and cross-tenant
    records. Canonical collections use the standard envelope and endpoint-bound
    cursor pagination. Timestamps are UTC ISO 8601 values and monetary amounts
    ending in Cents are integer cents. Responses use narrow serializers and
    exclude credentials, API keys, provider configuration, access tokens,
    webhook secrets, raw provider payloads, and internal workflow or activity
    data.
servers:
  - url: https://app.nautilus.co
security:
  - tenantApiKey: []
tags:
  - name: Contract
  - name: Cancellations
  - name: Sites
  - name: Products
  - name: Checkout links
  - name: Purchases
  - name: Contact lists
  - name: Contacts
  - name: Marketing
  - name: Forms
  - name: Vouchers
  - name: Links
  - name: Automations
  - name: Surveys
  - name: Cases
  - name: Sonny's POS
  - name: Analytics
  - name: Messaging
  - name: Legacy
    description: Deprecated noncanonical endpoints retained for compatibility.
paths:
  /api/v1/vouchers/redemptions:
    get:
      tags:
        - Vouchers
      summary: List voucher redemptions
      description: >-
        Returns only resources owned by the organization encoded in the tenant
        API key.
      operationId: listVoucherRedemptions
      parameters:
        - name: groupId
          in: query
          required: false
          schema:
            type: string
        - name: site
          in: query
          required: false
          schema:
            type: string
        - name: redeemedAfter
          in: query
          required: false
          schema:
            type: string
            format: date-time
            description: UTC ISO 8601 timestamp.
          description: >-
            Inclusive redemption lower bound. Must include an explicit UTC
            offset.
        - name: redeemedBefore
          in: query
          required: false
          schema:
            type: string
            format: date-time
            description: UTC ISO 8601 timestamp.
          description: >-
            Inclusive redemption upper bound. Must include an explicit UTC
            offset.
        - name: includeCodes
          in: query
          required: false
          schema:
            type: boolean
            default: false
          description: >-
            When true, includes fulfillment or voucher codes. Codes are excluded
            by default because they grant value.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 500
            default: 100
          description: >-
            Page size. Invalid values use 100; values above 500 are capped at
            500.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: >-
            Opaque continuation token returned by this voucher redemptions
            collection. Cursors are bound to this endpoint (and, for nested or
            sorted collections, to that parent or sort) and cannot be reused
            elsewhere.
      responses:
        '200':
          description: Tenant-scoped collection.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/CollectionEnvelope'
                  - type: object
                    properties:
                      data:
                        type: array
                        items:
                          $ref: '#/components/schemas/VoucherRedemption'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  schemas:
    CollectionEnvelope:
      type: object
      additionalProperties: false
      properties:
        organizationId:
          type: string
        filters:
          type: object
          additionalProperties: true
          description: Normalized filters actually applied to the request.
        data:
          type: array
          items: {}
        pagination:
          $ref: '#/components/schemas/Pagination'
      required:
        - organizationId
        - filters
        - data
        - pagination
      description: Standard envelope for canonical collection endpoints.
    VoucherRedemption:
      type: object
      additionalProperties: false
      properties:
        voucherId:
          type: string
        voucherGroupId:
          anyOf:
            - type: string
            - type: 'null'
        redeemedAt:
          type: string
          format: date-time
          description: UTC ISO 8601 timestamp.
        redeemedAtSite:
          anyOf:
            - type: string
            - type: 'null'
        recipient:
          type: object
          additionalProperties: false
          properties:
            email:
              anyOf:
                - type: string
                - type: 'null'
            phone:
              anyOf:
                - type: string
                - type: 'null'
          required:
            - email
            - phone
        code:
          type: string
      required:
        - voucherId
        - voucherGroupId
        - redeemedAt
        - redeemedAtSite
        - recipient
      description: code is omitted unless includeCodes=true.
    Pagination:
      type: object
      additionalProperties: false
      properties:
        limit:
          type: integer
        hasMore:
          type: boolean
        nextCursor:
          anyOf:
            - type: string
            - type: 'null'
      required:
        - limit
        - hasMore
        - nextCursor
    Error:
      type: object
      additionalProperties: false
      properties:
        error:
          type: string
      required:
        - error
  responses:
    BadRequest:
      description: >-
        Malformed parameters, unsupported provider, or unavailable resource for
        this organization.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Missing, invalid, legacy, or non-tenant Bearer credential.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InternalServerError:
      description: Internal server error. No internal exception data is exposed.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    tenantApiKey:
      type: http
      scheme: bearer
      bearerFormat: Clerk tenant API key
      description: >-
        Clerk tenant API key. The organizationId encoded by the key is the exact
        and only tenant scope.

````