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

# List redemptions

> Workspace redemptions for a burn-time window. Each item is a register row.



## OpenAPI

````yaml /api-reference/platform-api.json get /v2/redemptions
openapi: 3.0.0
info:
  title: Range Platform API
  description: >-
    The Range Platform API for workspace management, counterparties, and
    operational tooling.
  version: 1.7.31
  contact: {}
servers:
  - url: https://api.range.org
    description: Range API Server
security:
  - Authorization: []
  - Authorization: []
tags:
  - name: Address Information
    description: Get information about a crypto address.
  - name: Transfer Enrichments
    description: Attach workspace-scoped notes and categories to transfers.
  - name: Counterparties
    description: Manage external entities, their addresses, bank accounts, and documents.
  - name: Parties
    description: >-
      The workspace entity register: the firm itself, its clients, and its
      counterparties.
paths:
  /v2/redemptions:
    get:
      tags:
        - Redemptions
      summary: List redemptions
      description: >-
        Workspace redemptions for a burn-time window. Each item is a register
        row.
      operationId: list
      parameters:
        - name: redemption_token
          required: false
          in: query
          schema:
            type: string
        - name: state
          required: false
          in: query
          schema:
            type: string
            enum:
              - pending
              - done
              - done_late
              - failed
        - name: redeeming_address
          required: false
          in: query
          schema:
            type: string
        - name: start_time
          required: false
          in: query
          description: Inclusive start of the burn-time window. A date is midnight UTC.
          schema:
            type: string
        - name: end_time
          required: false
          in: query
          description: Exclusive end of the burn-time window. A date is midnight UTC.
          schema:
            type: string
        - name: sort
          required: false
          in: query
          schema:
            default: burn_time
            type: string
            enum:
              - burn_time
              - deadline
        - name: order
          required: false
          in: query
          description: >-
            Direction of the sort column, also applied to the id tie-breaker so
            pages stay stable.
          schema:
            default: asc
            type: string
            enum:
              - asc
              - desc
        - name: limit
          required: false
          in: query
          schema:
            minimum: 1
            maximum: 200
            type: number
        - name: cursor
          required: false
          in: query
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListRedemptionsResponseDto'
components:
  schemas:
    ListRedemptionsResponseDto:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/RedemptionRegisterItemDto'
        meta:
          $ref: '#/components/schemas/CursorMetaDto'
      required:
        - items
        - meta
    RedemptionRegisterItemDto:
      type: object
      properties:
        id:
          type: string
        burn_tx_hash:
          type: string
        log_index:
          type: number
          description: >-
            Position of the burn within its transaction. With burn_tx_hash it
            identifies the burn.
        burn_time:
          type: string
        amount:
          type: string
        redeeming_address:
          type: string
        deadline:
          type: string
        payout_reference:
          type: string
          nullable: true
        source_ref:
          type: string
          nullable: true
          description: >-
            Statement reference (source_ref). Stored and shown; never used to
            match.
        payout_date:
          type: string
          nullable: true
        payout_source:
          type: string
          nullable: true
          enum:
            - csv
            - api
            - manual
        state:
          type: string
          enum:
            - pending
            - done
            - done_late
            - failed
        late:
          type: boolean
        reportable:
          type: boolean
        case_resolution:
          type: string
          nullable: true
          enum:
            - dismissed
            - paid
        resolved_by:
          type: string
          nullable: true
        dismiss_reason:
          type: string
          nullable: true
        step:
          type: string
        waiting_for:
          type: string
          nullable: true
        payout_entered_by:
          type: string
          nullable: true
        payout_entered_at:
          type: string
          nullable: true
        case_id:
          type: string
          nullable: true
          description: >-
            The case opened when this redemption missed its deadline. Null when
            no case was opened.
      required:
        - id
        - burn_tx_hash
        - log_index
        - burn_time
        - amount
        - redeeming_address
        - deadline
        - state
        - late
        - reportable
        - step
    CursorMetaDto:
      type: object
      properties:
        next_cursor:
          type: string
          nullable: true
          description: >-
            Opaque string cursor pointing to the next page of results. null if
            there is no next page.
          example: eyJpZCI6IjkxeFFlV3Z...
        previous_cursor:
          type: string
          nullable: true
          description: >-
            Opaque string cursor pointing to the previous page of results. null
            if there is no previous page.
          example: eyJpZCI6IjkxeFFlV3Z...
        first_page_cursor:
          type: string
          description: >-
            Opaque string cursor pointing to the very first page in the entire
            dataset with respect to the current filter.
          example: eyJpZCI6IjkxeFFlV3Z...
        last_page_cursor:
          type: string
          nullable: true
          description: >-
            Opaque string cursor pointing to the very last page in the entire
            dataset with respect to the current filter.
          example: eyJpZCI6IjkxeFFlV3Z...
        total_count:
          type: number
          nullable: true
          description: Total number of results.
          example: 100
        page_number:
          type: number
          description: Current page number.
          example: 1
  securitySchemes:
    Authorization:
      type: apiKey
      in: header
      name: X-API-KEY
      description: Authorization method required to allow user to access the api endpoints.

````

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