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

# List all commissions



## OpenAPI

````yaml /api-reference/openapi.json get /commissions/
openapi: 3.0.3
info:
  title: Tapfiliate REST API
  version: '1.6'
  description: >-
    Reference for the Tapfiliate REST API. See the introduction for
    authentication, pagination and rate limits.
  x-generated-from: ApiBlueprint@e23e51f
servers:
  - url: https://api.tapfiliate.com/1.6
    description: Production
security:
  - ApiKey: []
tags:
  - name: Customers
    description: >-
      People who signed up or paid after being referred by an affiliate. With
      recurring or lifetime commissions, later conversions for the same customer
      go to the same affiliate.
  - name: Conversions
    description: >-
      Sales and other actions you pay commissions for. Each conversion has one
      or more commissions.
  - name: Commissions
    description: >-
      What an affiliate earns for a conversion. Approve or disapprove them
      before payout.
  - name: Affiliates
    description: >-
      The partners who promote your programs, with their meta data, notes,
      payout methods and balances.
  - name: Affiliate Groups
    description: Groups for organising your affiliates.
  - name: Affiliate Prospects
    description: >-
      People who signed up through a recruitment source but are not affiliates
      yet.
  - name: Programs
    description: >-
      Your affiliate programs, the affiliates in them and their commission
      settings.
  - name: Payments
    description: Settle affiliate balances and look up past payments.
  - name: Clicks
    description: Visits through affiliate links, the first step of attribution.
paths:
  /commissions/:
    get:
      tags:
        - Commissions
      summary: List all commissions
      operationId: listAllCommissions
      parameters:
        - name: affiliate_id
          in: query
          description: The affiliate Id
          example: janejameson
          schema:
            type: string
        - name: status
          in: query
          description: >-
            An optional approval status to filter by. Valid values are:
            `approved` | `disapproved` | `pending`
          example: approved
          schema:
            type: string
        - name: paid
          in: query
          description: 'Only show commissions that are paid out. Valid values are: `1` | `0`'
          example: '0'
          schema:
            type: boolean
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommissionsCollectionModel'
              example:
                - id: 111
                  amount: 5
                  approved: true
                  created_at: 2021-04-01T04:23:02+0000
                  commission_type: sales-bonus
                  comment: null
                  conversion: null
                  payout: null
                  affiliate:
                    id: janejameson
                    firstname: Jane
                    lastname: Jameson
                  kind: bonus
                  currency: EUR
                  final: null
                  finalization_date: null
                  commission_name: Sales bonus
                - id: 2
                  amount: 30
                  approved: true
                  created_at: 2021-04-01T04:23:02+0000
                  commission_type: standard
                  conversion_sub_amount: 300
                  comment: null
                  conversion:
                    id: 2
                  payout: null
                  affiliate:
                    id: janejameson
                    firstname: Jane
                    lastname: Jameson
                  kind: regular
                  currency: EUR
                  final: null
                  finalization_date: null
                  commission_name: standard
                - id: 1
                  amount: 55
                  approved: true
                  created_at: 2021-03-31T08:21:02+0000
                  commission_type: standard
                  conversion_sub_amount: 550
                  comment: null
                  conversion:
                    id: 1
                  payout: null
                  affiliate:
                    id: janejameson
                    firstname: Jane
                    lastname: Jameson
                  kind: regular
                  currency: USD
                  final: null
                  finalization_date: null
                  commission_name: standard
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    CommissionsCollectionModel:
      type: array
      items:
        type: object
        properties:
          id:
            type: number
          amount:
            type: number
          approved:
            type: boolean
          created_at:
            type: string
          commission_type:
            type: string
          comment:
            nullable: true
          conversion:
            type: object
            properties:
              id:
                type: number
          payout:
            nullable: true
          affiliate:
            type: object
            properties:
              id:
                type: string
              firstname:
                type: string
              lastname:
                type: string
          kind:
            type: string
          currency:
            type: string
          final:
            nullable: true
          finalization_date:
            nullable: true
          commission_name:
            type: string
          conversion_sub_amount:
            type: number
        required:
          - id
          - amount
          - approved
          - created_at
          - commission_type
          - comment
          - conversion
          - payout
          - affiliate
          - kind
          - currency
          - final
          - finalization_date
          - commission_name
          - conversion_sub_amount
    RequestError:
      type: object
      description: >-
        Errors raised before the endpoint runs: authentication, access, unknown
        path, server error.
      properties:
        message:
          type: string
        code:
          type: integer
        traceId:
          type: string
          description: Send this to support to find the request.
      required:
        - message
        - code
  responses:
    Unauthorized:
      description: The API key is missing or wrong
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RequestError'
          example:
            message: Authentication Failed.
            code: 401
    Forbidden:
      description: No API access or no permission for this action
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RequestError'
          example:
            message: Forbidden
            code: 403
            traceId: 04ed655728a22bc0d39f
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: X-Api-Key
      description: Your API key, from your Tapfiliate account settings.

````

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