Creators · Creator Portal
Returns a creator's earnings history, one page at a time.
GET
https://api.pozy.ai/public/creator-campaigns/{token}/payoutsPublic, no API keygetCreatorPayouts
Guide: Run a campaign
Request
This endpoint is public. Call it without an API key.
Path parameters
| Name | Type | Notes |
|---|---|---|
tokenrequired | string | Matches ^[A-Za-z0-9_-]{16,128}$ |
Query parameters
| Name | Type | Notes |
|---|---|---|
limit | integer | Default 501 to 200 |
skip | integer | Default 0At least 0 |
Example
curl -X GET "https://api.pozy.ai/public/creator-campaigns/string/payouts?limit=50"const res = await fetch("https://api.pozy.ai/public/creator-campaigns/string/payouts?limit=50");
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);import os
import requests
resp = requests.get(
"https://api.pozy.ai/public/creator-campaigns/string/payouts",
params={
"limit": 50,
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
entriesarray of objectrequired7 child fields
idstringrequiredkindstringrequiredOne of
accrual,approval,hold_release,adjustment,settling,settlement,reversal,topup,transfer,fee.amountCentsintegerrequiredfromBucketstringrequiredCan be null.
toBucketstringrequiredCan be null.
holdUntilstring (date-time)requiredCan be null.
createdAtstring (date-time)required
totalintegerrequiredpayoutsobjectrequiredmodestringrequiredOne of
none,external,treasury.statusstringrequiredOne of
not_started,pending,enabled,not_applicable.countrystringrequiredCan be null.
transfersarray of objectrequired3 child fields
idstringrequiredamountCentsintegerrequiredcreatedAtstring (date-time)required
200 response
{
"entries": [
{
"id": "6bfebd43ddc270f6d2c56fc5",
"kind": "accrual",
"amountCents": 1,
"fromBucket": "string",
"toBucket": "string",
"holdUntil": "2026-10-02T09:00:00.000Z",
"createdAt": "2026-10-02T09:00:00.000Z"
}
],
"total": 42,
"payouts": {
"mode": "none",
"status": "not_started",
"country": "US",
"transfers": [
{
"id": "6bfebd43ddc270f6d2c56fc5",
"amountCents": 1,
"createdAt": "2026-10-02T09:00:00.000Z"
}
]
}
}Errors
Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:
| 400 | invalid_request_error | A parameter or body field is missing or invalid. param names it. |
| 404 | not_found | Nothing with that id exists in your workspace. |
| 429 | rate_limit_error | Too many requests this minute. Wait for Retry-After seconds. |
Every code is listed in Errors.