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

# List claims

> Returns a paginated list of claims with optional filtering

```bash OAuth Scope theme={null}
rewards:read_claims
```


## OpenAPI

````yaml get /rewards/claims
openapi: 3.0.0
info:
  title: Paxos Rewards API
  version: v2-preview
servers: []
security: []
paths:
  /rewards/claims:
    get:
      tags:
        - Claims
      summary: List claims
      description: Returns a paginated list of claims with optional filtering.
      operationId: ListClaims
      parameters:
        - name: payout_group_id
          in: query
          required: false
          schema:
            type: string
        - name: onchain_statuses
          description: Filter by onchain_status values.
          in: query
          required: false
          explode: true
          schema:
            type: array
            items:
              $ref: '#/components/schemas/ClaimOnchainStatus'
        - name: chain
          in: query
          required: false
          schema:
            type: string
        - name: jurisdiction
          in: query
          required: false
          schema:
            type: string
        - name: start_time
          description: Start time filter (inclusive).
          in: query
          required: false
          schema:
            type: string
            format: date-time
        - name: end_time
          description: End time filter (inclusive).
          in: query
          required: false
          schema:
            type: string
            format: date-time
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            format: int32
        - name: page_cursor
          in: query
          required: false
          schema:
            type: string
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListClaimsResponse'
      security:
        - OAuth2:
            - rewards:read_claims
components:
  schemas:
    ClaimOnchainStatus:
      type: string
      enum:
        - PENDING
        - SUBMITTED
        - CONFIRMED
        - FAILED
    ListClaimsResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Claim'
          description: Claims in this page of results.
        next_page_cursor:
          type: string
          description: >-
            Token to retrieve the next page of results, or empty if there are no
            more results.
    Claim:
      type: object
      title: A reward claim transaction
      properties:
        id:
          type: string
        payout_group_id:
          type: string
        claim_type:
          $ref: '#/components/schemas/ClaimType'
        claim_schedule_id:
          type: string
          description: Present if triggered by a schedule.
        onchain_status:
          $ref: '#/components/schemas/ClaimOnchainStatus'
        amount:
          type: string
          description: Amount in business units (e.g., "123.456789" for USDG).
        tx_hash:
          type: string
        addresses:
          type: array
          items:
            type: string
          description: Populated for CLAIM_FOR_ADDRESSES type.
        error_message:
          type: string
        blockchain:
          type: string
        asset_type:
          type: string
        submitted_at:
          type: string
          format: date-time
        confirmed_at:
          type: string
          format: date-time
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    ClaimType:
      type: string
      enum:
        - CLAIM_ALL
        - CLAIM_FOR_ADDRESSES
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://oauth.paxos.com/oauth2/token
          scopes:
            rewards:read_monitoring_address: Read reward addresses
            rewards:write_monitoring_address: Create and manage reward addresses
            rewards:read_claims_schedule: Read claim schedules
            rewards:write_claims_schedule: Create and manage claim schedules
            rewards:read_claims: Read claims
            rewards:read_payout_groups: Read payout groups
            rewards:write_payout_groups: Create and manage payout groups
            rewards:read_rewards_details: Read reward details

````