Bloss Docs

Creators' payouts in a cycle

Developers
GET
/brands/{brandId}/payout-cycles/{cycleId}/payouts

One row per creator paid in the cycle, as in the cycle's table on Payouts › Cycles: base, bonus, what was already sent early or per set, what is due at cycle end, and whether and how it was paid. Ordered by creation, newest first.

Authorization

bearerAuth payouts:read
headerAuthorizationBearer <token>

Personal access token. Scopes: account:read, creator:read, creator:earnings, managed:read, coach:read, brand:read, creators:read, videos:read, analytics:read, recruitment:read, engagement:read, support:read, integrations:read, payouts:read, funds:read, billing:read.

Scope: payouts:read

Path Parameters

brandId*string

A brand id from GET /me or GET /creator/brands.

Length1 <= length
cycleId*string

A payout cycle id from GET /brands/{brandId}/payout-cycles.

Length1 <= length

Query Parameters

limit?integer

Page size, 1–100. Default 50.

Range1 <= value <= 100
Default50
cursor?string

The nextCursor from the previous page. Omit for the first page.

Length1 <= length

Response Body

Success.

application/json
  1. response
data*array<>
nextCursor*|

Pass as cursor to get the next page; null on the last page.

curl -X GET 'https://example.com/api/v1/brands/string/payout-cycles/string/payouts'
{  "data": [    {      "id": "string",      "creator": {        "id": "string",        "name": "string",        "status": "string"      },      "status": "string",      "basePay": 0,      "bonusPay": 0,      "paidEarly": 0,      "bonusPaidPerSet": 0,      "due": 0,      "total": 0,      "eligibleViews": 0,      "statsSnapshotDate": "string",      "paidAt": "string",      "paidVia": "string",      "transferId": "string",      "notes": "string",      "updatedAt": "string"    }  ],  "nextCursor": "string"}

Was this page helpful?