Skip to main content
GET
/
payouts
/
group_by_promoters
Get all payouts grouped by promoters
curl --request GET \
  --url https://api.firstpromoter.com/api/v2/company/payouts/group_by_promoters \
  --header 'Account-ID: <account-id>' \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "promoter": {
        "id": 123,
        "email": "<string>",
        "name": "<string>",
        "invoice_details_status": "<string>",
        "fraud_suspicions": [
          "<string>"
        ],
        "profile": {
          "invoice_details_validation_errors": {}
        }
      },
      "payout_method": {
        "id": 123,
        "method": "<string>",
        "date_added": "2023-11-07T05:31:56Z",
        "is_disabled": true,
        "meta": {},
        "is_selected": true,
        "details": {},
        "managed_payouts": true
      },
      "payouts": [
        {
          "id": 123,
          "status": "pending",
          "amount": 123,
          "payments_batch_id": 123,
          "tax_rate": 123,
          "unit": "<string>",
          "period_start": "2023-11-07T05:31:56Z",
          "period_end": "2023-11-07T05:31:56Z",
          "paid_at": "2023-11-07T05:31:56Z",
          "processing_started_at": "2023-11-07T05:31:56Z",
          "failed_at": "2023-11-07T05:31:56Z",
          "error": "<string>",
          "total_incl_tax": 123,
          "created_at": "2023-11-07T05:31:56Z",
          "payout_method": {
            "id": 123,
            "method": "<string>",
            "date_added": "2023-11-07T05:31:56Z",
            "is_disabled": true,
            "meta": {},
            "is_selected": true,
            "details": {},
            "managed_payouts": true
          },
          "promoter": {
            "id": 123,
            "email": "<string>",
            "name": "<string>"
          },
          "campaign": {
            "id": 123,
            "name": "<string>",
            "color": "<string>"
          },
          "invoice": {
            "id": 123,
            "number": "<string>"
          }
        }
      ],
      "is_amount_payable": true,
      "payout_ids": [
        123
      ],
      "amount": 123,
      "total_incl_tax": 123
    }
  ],
  "meta": {
    "total": 123,
    "promoters_count": 123,
    "total_incl_tax": 123,
    "due_date": "2023-12-25",
    "period_end": "2023-12-25"
  }
}

Authorizations

​
Authorization
string
header
required

Access token passed as a Bearer token in the Authorization header

Headers

​
Account-ID
string
required

Account identifier that specifies which account is making the request

Example:

"acc_123456"

Query Parameters

​
q
string

Search params. Searches by 'promoter.profile.first_name,promoter.profile.last_name,promoter.user.email`

​
filters[status]
enum<string>

Filter by status

Available options:
pending,
completed,
failed,
processing,
cancelled
​
filters[campaign_id]

Campaign ids. Can be Integer or Array of Integers

​
include_payout_method_details
boolean

Set it true to include the payout_method_details

​
filters[min_payment]
integer

Filters payouts by the minimum payment amount possible

​
filters[invoiceable]
enum<string>

Filters payouts by invoiceable

Available options:
true,
false,
not_set

Response

Successful response

​
data
object[]
​
meta
object