> ## 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.
# List payouts
> With this endpoint, you can list all payouts for a promoter, a campaign, or the entire account using the API. **HTTP Request**
`GET https://firstpromoter.com/api/v1/payouts/list`
## OpenAPI
````yaml openapi-payouts GET /list
openapi: 3.0.1
info:
title: FirstPromoter Payouts API
description: >-
The Payouts API lets you list and change the payouts status of your
promoters.
license:
name: MIT
version: 1.0.0
servers:
- url: https://firstpromoter.com/api/v1/payouts
security:
- apiKeyAuth: []
paths:
/list:
get:
description: >-
With this endpoint, you can list all payouts for a promoter, a campaign,
or the entire account using the API. **HTTP Request**
`GET https://firstpromoter.com/api/v1/payouts/list`
parameters:
- name: promoter_id
in: query
description: List all payouts assigned to a promoter
schema:
type: string
- name: campaign_id
in: query
description: List all payouts of a campaign
schema:
type: string
- name: status
in: query
description: Filter payouts by status.
schema:
type: string
enum:
- pending
- processing
- completed
responses:
'200':
description: Success response
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: integer
example: 2709255
status:
type: string
example: completed
amount:
type: integer
example: 12
date_paid:
type: string
format: date-time
example: '2024-09-04T15:23:20.630Z'
due_date:
type: string
nullable: true
example: null
unit:
type: string
example: points
created_at:
type: string
format: date-time
example: '2024-09-04T15:23:16.392Z'
has_issues:
type: boolean
example: false
reward:
type: object
properties:
id:
type: integer
example: 140362
amount:
type: integer
example: 0
type:
type: string
example: per_promotion
unit:
type: string
example: points
name:
type: string
example: Points
per_of_sale:
type: integer
example: 0
default_promo_code:
type: string
nullable: true
example: null
promoter:
type: object
properties:
id:
type: integer
example: 8736661
status:
type: string
example: active
cust_id:
type: string
nullable: true
example: null
email:
type: string
example: test+demo2@mail.com
created_at:
type: string
format: date-time
example: '2024-08-21T17:08:40.500Z'
temp_password:
type: string
nullable: true
example: api@test1A0
default_promotion_id:
type: integer
example: 10008220
pref:
type: string
example: 2ejxve3
default_ref_id:
type: string
example: i4fth
note:
type: string
nullable: true
example: null
w8_form_url:
type: string
nullable: true
example: null
w9_form_url:
type: string
nullable: true
example: null
parent_promoter_id:
type: integer
nullable: true
example: null
earnings_balance:
type: object
properties:
cash:
type: integer
example: 28800
points:
type: integer
example: 24
free_months:
type: integer
example: 3
current_balance:
type: object
properties:
cash:
type: integer
example: 28800
points:
type: integer
example: -24
free_months:
type: integer
example: -3
paid_balance:
type: object
properties:
points:
type: integer
example: 48
free_months:
type: integer
example: 6
auth_token:
type: string
example: pDdv3MnxH86p8s2WxJfMpSJfsYNV6SxX
campaign:
type: object
properties:
id:
type: integer
example: 26127
name:
type: string
example: Make Campaign
landing_url:
type: string
example: https://lastechworld.com
description:
type: string
nullable: true
example: null
private:
type: boolean
example: false
color:
type: string
example: '#26a69a'
default_webhook_url:
type: string
example: >-
https://hook.eu1.make.com/mw5u7tb7mnopiriozq8nb6wbeb82omrd
auto_approve_rewards:
type: boolean
example: true
auto_approve_promoters:
type: boolean
example: true
components:
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: X-API-KEY
````