> ## 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
> With this endpoint you can list all payouts.
**HTTP Request**
`GET https://api.firstpromoter.com/api/v2/company/payouts`
## OpenAPI
````yaml openapi-v2-payouts get /payouts
openapi: 3.0.3
info:
title: FirstPromoter Admin Payouts API
description: API documentation for admin payouts endpoints
version: 1.0.0
servers:
- url: https://api.firstpromoter.com/api/v2/company
description: Production server
security:
- BearerAuth: []
paths:
/payouts:
get:
summary: Get all payouts
description: |-
With this endpoint you can list all payouts.
**HTTP Request**
`GET https://api.firstpromoter.com/api/v2/company/payouts`
operationId: getAdminPayouts
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`
required: false
schema:
type: string
- name: ids[]
in: query
description: Array of payout ids to get
required: false
schema:
type: array
items:
type: integer
- name: filters[status]
in: query
description: Filter by status
required: false
schema:
type: string
enum:
- pending
- completed
- failed
- processing
- cancelled
- name: filters[campaign_id]
in: query
description: Campaign ids. Can be Integer or Array of Integers
required: false
schema:
oneOf:
- type: integer
- type: array
items:
type: integer
- name: filters[payments_batch_id]
in: query
description: Payment batches ids. Can be Integer or Array of Integers
required: false
schema:
oneOf:
- type: integer
- type: array
items:
type: integer
- name: filters[due_period]
in: query
description: Due period
required: false
schema:
type: string
enum:
- next
- overdue
- custom
- name: filters[period_start][from]
in: query
description: period_start starting from date
required: false
schema:
type: string
format: date
- name: filters[period_start][to]
in: query
description: period_start end at date
required: false
schema:
type: string
format: date
- name: filters[period_end][from]
in: query
description: period_end starting from date
required: false
schema:
type: string
format: date
- name: filters[period_end][to]
in: query
description: period_end end at date
required: false
schema:
type: string
format: date
- name: filters[payout_method]
in: query
description: Payout method
required: false
schema:
type: string
enum:
- paypal
- bank
- wise
- crypto
- custom
- dots
- not_set
- name: filters[promoter_id]
in: query
description: Promoter id
required: false
schema:
type: integer
- name: filters[only_payable]
in: query
description: Only payable payouts
required: false
schema:
type: boolean
- name: filters[group_ref]
in: query
description: Group reference
required: false
schema:
type: string
- name: filters[fraud_suspicions]
in: query
description: >-
Fraud suspicions. Multiple values can be passed as an array. Send
['no_suspicion'] to filter promoters with no fraud suspicions
required: false
schema:
type: array
items:
type: string
enum:
- same_ip_suspicion
- same_promoter_email
- ad_source
- no_suspicion
- name: sorting[amount]
in: query
description: The sort by amount direction
required: false
schema:
type: string
enum:
- asc
- desc
- name: sorting[period_start]
in: query
description: Period start
required: false
schema:
type: string
enum:
- asc
- desc
- name: sorting[period_end]
in: query
description: Period end
required: false
schema:
type: string
enum:
- asc
- desc
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Payout'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
parameters:
AccountId:
name: Account-ID
in: header
required: true
description: Account identifier that specifies which account is making the request
schema:
type: string
example: acc_123456
schemas:
Payout:
type: object
properties:
id:
type: integer
description: Unique identifier for the payout
status:
type: string
enum:
- pending
- completed
- failed
- processing
- cancelled
description: Status of the payout
amount:
type: number
format: float
description: Amount of the payout
payments_batch_id:
type: integer
description: ID of the payments batch
tax_rate:
type: number
format: float
description: Tax rate applied to the payout
unit:
type: string
description: Unit of the payout (e.g., cash)
period_start:
type: string
format: date-time
description: Start date of the period
period_end:
type: string
format: date-time
description: End date of the period
paid_at:
type: string
format: date-time
description: Date when the payout was paid
processing_started_at:
type: string
format: date-time
description: Date when the payout processing started
failed_at:
type: string
format: date-time
description: Date when the payout failed
error:
type: string
description: Error message if the payout failed
total_incl_tax:
type: number
format: float
description: Total amount including tax
created_at:
type: string
format: date-time
description: Date when the payout was created
payout_method:
type: object
properties:
id:
type: integer
description: ID of the payout method
method:
type: string
description: Payout method name
date_added:
type: string
format: date-time
description: Date when the payout method was added
is_disabled:
type: boolean
description: Whether the payout method is disabled
meta:
type: object
description: Additional meta information
is_selected:
type: boolean
description: Whether the payout method is selected
details:
type: object
description: Details about the payout method
managed_payouts:
type: boolean
description: Whether payouts are managed by us (auto-payouts)
promoter:
type: object
properties:
id:
type: integer
description: ID of the promoter
email:
type: string
description: Email of the promoter
name:
type: string
description: Name of the promoter
campaign:
type: object
properties:
id:
type: integer
description: ID of the campaign
name:
type: string
description: Name of the campaign
color:
type: string
description: Color of the campaign
Error:
type: object
properties:
message:
type: string
description: Error message
code:
type: string
description: Error code
required:
- message
- code
securitySchemes:
BearerAuth:
type: http
scheme: bearer
description: Access token passed as a Bearer token in the Authorization header
````