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

# List commissions



## OpenAPI

````yaml /openapi.yaml get /v1/commissions
openapi: 3.1.0
info:
  title: Affixo API
  version: 1.0.0
  description: |
    The Affixo REST API for affiliate program management and server-to-server
    conversion tracking.

    All requests authenticate with a workspace key (`sa_live_…`) as a Bearer
    token. Scopes: `read` / `write` / `track` / `*`.

    Rate limit: 600 req/min per key (enforced at the edge).
servers:
  - url: https://go.affixo.dev
    description: Production
security: []
tags:
  - name: Affiliates
    description: Manage affiliates (workspace key)
  - name: Campaigns
    description: Create and configure campaigns + commission rules (workspace key)
  - name: Links
    description: Manage referral links (workspace key)
  - name: Risk
    description: AI risk assessments for fraud triage (workspace key)
  - name: Commissions
    description: Approve, deny, and manage commissions (workspace key)
  - name: Conversions
    description: Re-attribute and manage conversions (workspace key)
  - name: Webhooks
    description: Manage webhook endpoint subscriptions (workspace key)
  - name: Reports
    description: Aggregated reporting data (workspace key)
  - name: Resources
    description: Read campaigns, commissions, conversions, payouts (workspace key)
  - name: Tracking
    description: >-
      Server-to-server click & conversion tracking (workspace key, scope
      "track")
paths:
  /v1/commissions:
    get:
      tags:
        - Commissions
      summary: List commissions
      parameters:
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/Offset'
        - name: status
          in: query
          schema:
            type: string
            example: confirmed
          description: >-
            Filter by commission status (pending, confirmed, held, blocked,
            denied, reversed, paid, approved). `confirmed` is the payable
            "approved" state; the stored `approved` status marks imported
            FirstPromoter history that is settled and never paid out here — do
            not poll `status=approved` to detect payable commissions.
      responses:
        '200':
          description: A page of commissions
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/ListEnvelope'
                  - type: object
                    properties:
                      data:
                        type: array
                        items:
                          $ref: '#/components/schemas/Commission'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/InsufficientScope'
      security:
        - WorkspaceKey: []
components:
  parameters:
    Limit:
      name: limit
      in: query
      description: Page size (1–200, default 50).
      schema:
        type: integer
        minimum: 1
        maximum: 200
        default: 50
    Offset:
      name: offset
      in: query
      description: Rows to skip (default 0).
      schema:
        type: integer
        minimum: 0
        default: 0
  schemas:
    ListEnvelope:
      type: object
      properties:
        object:
          type: string
          example: list
        resource:
          type: string
          example: affiliates
        limit:
          type: integer
          example: 50
        offset:
          type: integer
          example: 0
        data:
          type: array
          items: {}
    Commission:
      type: object
      properties:
        id:
          type: string
          format: uuid
        affiliate_id:
          type: string
          format: uuid
        conversion_id:
          type: string
          format: uuid
        amount:
          type: number
        currency:
          type: string
          example: usd
        status:
          type: string
          example: pending
        period_index:
          type: integer
          nullable: true
        created_at:
          type: string
          format: date-time
    Error:
      type: object
      properties:
        error:
          type: string
        need:
          type: string
          description: Present on insufficient_scope.
        detail:
          type: string
  responses:
    Unauthorized:
      description: Missing or invalid bearer token
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: unauthorized
    InsufficientScope:
      description: The key lacks the required scope
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: insufficient_scope
            need: write
  securitySchemes:
    WorkspaceKey:
      type: http
      scheme: bearer
      description: 'Workspace API key, e.g. `sa_live_…`. Scopes: read / write / track / *.'

````