---
title: "Get all payouts"
method: GET
path: "/payouts"
---

# Get all payouts

`GET /payouts`

With this endpoint you can list all payouts. 
 <Tip>**HTTP Request** <br/>`GET https://api.firstpromoter.com/api/v2/company/payouts`</Tip>

## Query parameters

- `q` string
- `ids[]` integer[]
- `filters[status]` 'pending' | 'completed' | 'failed' | 'processing' | 'cancelled'
- `filters[campaign_id]` union
  - integer
  - integer[]
- `filters[payments_batch_id]` union
  - integer
  - integer[]
- `filters[due_period]` 'next' | 'overdue' | 'custom'
- `filters[period_start][from]` string, date
- `filters[period_start][to]` string, date
- `filters[period_end][from]` string, date
- `filters[period_end][to]` string, date
- `filters[payout_method]` 'paypal' | 'bank' | 'wise' | 'crypto' | 'custom' | 'dots' | 'not_set'
- `filters[promoter_id]` integer
- `filters[only_payable]` boolean
- `filters[group_ref]` string
- `filters[fraud_suspicions]` string[]
- `sorting[amount]` 'asc' | 'desc'
- `sorting[period_start]` 'asc' | 'desc'
- `sorting[period_end]` 'asc' | 'desc'

## Headers

- `Account-ID` string, required

## Response `200`

Successful response

- Payout[]
  - `id` integer — Unique identifier for the payout
  - `status` 'pending' | 'completed' | 'failed' | 'processing' | 'cancelled' — Status of the payout
  - `amount` number, float — Amount of the payout
  - `payments_batch_id` integer — ID of the payments batch
  - `tax_rate` number, float — Tax rate applied to the payout
  - `unit` string — Unit of the payout (e.g., cash)
  - `period_start` string, date-time — Start date of the period
  - `period_end` string, date-time — End date of the period
  - `paid_at` string, date-time — Date when the payout was paid
  - `processing_started_at` string, date-time — Date when the payout processing started
  - `failed_at` string, date-time — Date when the payout failed
  - `error` string — Error message if the payout failed
  - `total_incl_tax` number, float — Total amount including tax
  - `created_at` string, date-time — Date when the payout was created
  - `payout_method` object
    - `id` integer — ID of the payout method
    - `method` string — Payout method name
    - `date_added` string, date-time — Date when the payout method was added
    - `is_disabled` boolean — Whether the payout method is disabled
    - `meta` object — Additional meta information
    - `is_selected` boolean — Whether the payout method is selected
    - `details` object — Details about the payout method
    - `managed_payouts` boolean — Whether payouts are managed by us (auto-payouts)
  - `promoter` object
    - `id` integer — ID of the promoter
    - `email` string — Email of the promoter
    - `name` string — Name of the promoter
  - `campaign` object
    - `id` integer — ID of the campaign
    - `name` string — Name of the campaign
    - `color` string — Color of the campaign

## Other responses

- `401` — Unauthorized
- `403` — Forbidden

---

[API](https://skmtc.net/firstpromoter/apis/firstpromoter-batch-processes-api.md) · [All operations](https://skmtc.net/firstpromoter/apis/firstpromoter-batch-processes-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/firstpromoter/firstpromoter-batch-processes-api/versions/e15f0d026ccf/schema)