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

# Get all payouts

> List the signed-in promoter's payouts, filtered by status, campaign or payments batch.



## OpenAPI

````yaml openapi-v2-affiliate-payouts get /payouts
openapi: 3.0.1
info:
  title: FirstPromoter Affiliate Payouts API
  version: '1.0'
  description: API for managing affiliate payouts
servers:
  - url: https://api.firstpromoter.com/api/v2/affiliate
security:
  - BearerAuth: []
paths:
  /payouts:
    get:
      tags:
        - Payouts
      summary: Get all payouts
      parameters:
        - $ref: '#/components/parameters/AccountId'
        - name: q
          in: query
          description: >-
            Search params. Searches by 'promoter.profile.first_name`,
            `promoter.profile.last_name`, `promoter.user.email`
          schema:
            type: string
        - name: filters[status]
          in: query
          description: Status filter
          schema:
            type: string
            enum:
              - pending
              - completed
              - failed
              - processing
              - cancelled
        - name: filters[campaign_id]
          in: query
          description: Campaign ids filter
          schema:
            oneOf:
              - type: integer
              - type: array
                items:
                  type: integer
        - name: filters[payments_batch_id]
          in: query
          description: Payment batches ids filter
          schema:
            oneOf:
              - type: integer
              - type: array
                items:
                  type: integer
        - name: filters[due_period]
          in: query
          description: Due period filter
          schema:
            type: string
            enum:
              - next
              - overdue
              - custom
        - name: filters[period_start]
          in: query
          description: >-
            Period start filter. Send "not_set" for returning the ones with
            period_start == null
          schema:
            type: string
            format: date
        - name: filters[period_end]
          in: query
          description: >-
            Period end filter. Send "not_set" for returning the ones with
            period_end == null
          schema:
            type: string
            format: date
        - name: filters[payout_method]
          in: query
          description: Payout method filter
          schema:
            type: string
            enum:
              - paypal
              - bank
              - wise
              - crypto
              - custom
              - dots
              - not_set
        - name: filters[group_ref]
          in: query
          description: Group ref filter
          schema:
            type: string
      responses:
        '200':
          description: List of payouts
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Payout'
                  meta:
                    $ref: '#/components/schemas/PayoutMeta'
        '401':
          description: >-
            Unauthorized — the API key is missing, wrong, regenerated or
            disabled (no JSON response body is returned), or the `Account-ID`
            header is missing.
          content:
            application/json:
              schema:
                type: object
              example: {}
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  parameters:
    AccountId:
      name: Account-ID
      in: header
      required: true
      description: >-
        Account ID of the affiliate program, shown next to your API key under
        Profile → API & AI tools
      schema:
        type: string
        example: acc_123456
  schemas:
    Payout:
      type: object
      properties:
        id:
          type: integer
        status:
          type: string
          enum:
            - pending
            - completed
            - failed
            - processing
            - cancelled
        amount:
          type: number
          format: float
        payments_batch_id:
          type: integer
        tax_rate:
          type: number
          format: float
        unit:
          type: string
        period_start:
          type: string
          format: date
        period_end:
          type: string
          format: date
        paid_at:
          type: string
          format: date-time
        processing_started_at:
          type: string
          format: date-time
        failed_at:
          type: string
          format: date-time
        error:
          type: string
        total_incl_tax:
          type: number
          format: float
        created_at:
          type: string
          format: date-time
        payout_method:
          type: object
        promoter:
          type: object
          properties:
            id:
              type: integer
            email:
              type: string
            name:
              type: string
        campaign:
          type: object
          properties:
            id:
              type: integer
            name:
              type: string
            color:
              type: string
    PayoutMeta:
      type: object
      properties:
        net_payout_days:
          type: integer
        payout_cycle:
          type: string
        min_payment:
          type: number
          format: float
        min_paying_customers:
          type: integer
        terms_description:
          type: string
        selected_payout_methods:
          type: array
          items:
            type: string
        payout_method_options:
          type: object
        managed_payouts:
          type: boolean
    Error:
      type: object
      properties:
        message:
          type: string
        code:
          type: string
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
  responses:
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your affiliate API key (Profile → API & AI tools in the affiliate
        dashboard), sent as `Authorization: Bearer {api_key}`

````

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