List payouts

Your creator payouts, the same rows as the dashboard’s Payouts page, newest first unless sorted. Values come from the payouts cache: a payout that is recalculating is returned with pending_update true and null amounts. Replaces /stats/creator_payouts for reading.

GET /payouts

List payouts

cURL

curl --request GET \
  --url https://api.growi.io/api/public/v1/payouts \
  --header 'Authorization: Bearer <token>'

200

{
  "success": true,
  "data": [
    {
      "id": 123,
      "uuid": "<string>",
      "creator_id": 123,
      "creator_name": "<string>",
      "creator_avatar_url": "<string>",
      "campaign_id": 123,
      "campaign_name": "<string>",
      "campaign_category": "<string>",
      "amount": "<string>",
      "amount_cents": 123,
      "deal_date": "2023-12-25",
      "since_date": "2023-12-25",
      "views": "<string>",
      "status": "<string>",
      "contents_delivered": 123,
      "contents_required": 123,
      "credits_enabled": true,
      "credit_name": "<string>",
      "total_credit_amount": 123,
      "formatted_total_credit_amount": "<string>",
      "pending_update": true
    }
  ],
  "pagination": {
    "page": 123,
    "per_page": 123,
    "pages": 123,
    "count": 123
  },
  "meta": {
    "precomputed_count": 123,
    "queued_count": 123,
    "in_flight_count": 123,
    "filtered_unknown_count": 123,
    "queue_state": "<string>"
  }
}

Replaces /stats/creator_payouts, which is deprecated.

Each payout has a state: ready, canceled, or updating while it recalculates. An updating payout has pending_update: true and null amounts, dates, views and content counts until it’s ready. While payouts are being recalculated for your whole organization, every row comes back updating with null amounts. Call again in a few minutes.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

organization_id · integer

Read one of your child brands instead of the organization that owns the key. Any id that is not one of your brands answers 404.

invoice_status · enum<string>

all (default), due, in_progress, open, paid, completed or canceled.

Available options: all, due, in_progress, open, paid, completed, canceled

campaign_id · integer

Only this campaign of your organization (404 otherwise).

creator_id · integer

Only this creator (Growi user id).

cycle · integer

Only this payout cycle number (1 = first).

payout_type · enum<string>

Only TikTok Shop contest payouts, or everything else.

Available options: contest, not_contest

search · string

Creator name, email or payout uuid.

start_date · string<date>

With invoice_status=paid: paid on or after this day, YYYY-MM-DD.

end_date · string<date>

With invoice_status=paid: paid on or before this day, YYYY-MM-DD.

sort_by · enum<string>

Sort column.

Available options: campaign, total_amount, bonus_amount, ad_spend_amount, cycle, attribution, metrics

sort_direction · enum<string>

desc (default) or asc.

Available options: asc, desc

page · integer

Page number, from 1. 404 past the last page.

per_page · integer

Rows per page, 1-100. Default 25.

Response

200

application/json

OK

success · boolean

data · object[]

Show child attributes

pagination · object

Show child attributes

meta · object

Show child attributes