---
title: "Get all payouts grouped by promoters"
method: GET
path: "/payouts/group_by_promoters"
---

# Get all payouts grouped by promoters

`GET /payouts/group_by_promoters`

## Request

- Base URL: `https://api.firstpromoter.com/api/v2/company`
- URL: `https://api.firstpromoter.com/api/v2/company/payouts/group_by_promoters`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/firstpromoter/apis/firstpromoter-batch-processes-api/docs/payouts/group_by_promoters/get.ts> (a function with typed inputs; its response is checked against the schema)

This endpoint returns all payouts but grouped by promoters. 
 <Tip>**HTTP Request** <br/>`GET https://api.firstpromoter.com/api/v2/company/payouts/group_by_promoters`</Tip>

## Query parameters

- `q` string
- `filters[status]` 'pending' | 'completed' | 'failed' | 'processing' | 'cancelled'
- `filters[campaign_id]` union
  - integer
  - integer[]
- `include_payout_method_details` boolean
- `filters[min_payment]` integer
- `filters[invoiceable]` 'true' | 'false' | 'not_set'

## Headers

- `Account-ID` string, required

## Response `200`

Successful response

- PayoutsGroupedByPromoters
  - `data` object[]
    - `promoter` object
      - `id` integer: ID of the promoter
      - `email` string: Email of the promoter
      - `name` string: Name of the promoter
      - `invoice_details_status` string: Status of invoice details
      - `fraud_suspicions` string[]: List of fraud suspicions
      - `profile` object
        - `invoice_details_validation_errors` object: Validation errors for invoice details
    - `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)
    - `payouts` 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
    - `is_amount_payable` boolean: Whether the amount is payable
    - `payout_ids` integer[]: List of payout IDs
    - `amount` number: Total amount
    - `total_incl_tax` number: Total amount including tax
  - `meta` object
    - `total` number: Total amount
    - `promoters_count` integer: Count of promoters
    - `total_incl_tax` number: Total amount including tax
    - `due_date` string, date: Due date
    - `period_end` string, date: End date of the period

## Other responses

- `401`: Unauthorized
- `403`: Forbidden

---

[API](https://skmtc.dev/firstpromoter/apis/firstpromoter-batch-processes-api.md) - [All operations](https://skmtc.dev/firstpromoter/apis/firstpromoter-batch-processes-api/llms.txt) - [OpenAPI document](https://skmtc.dev/firstpromoter/apis/firstpromoter-batch-processes-api/revisions/e15f0d026ccf?raw)