Bloss Docs

The brand's payout cycles

Developers
GET
/brands/{brandId}/cycles

The brand's payout cycles, newest first: id, first and last day, and status. Use the ids as cycleIds on the campaign endpoints. No amounts: those are on the payout endpoints.

Authorization

bearerAuth analytics: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: analytics:read

Path Parameters

brandId*string

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

Length1 <= length

Response Body

Success.

application/json
  1. response
data*array<>
curl -X GET 'https://example.com/api/v1/brands/string/cycles'
{  "data": [    {      "cycleId": "string",      "startDate": "string",      "endDate": "string",      "status": "string",      "current": true    }  ]}

Was this page helpful?

List the brand's creators GET

The roster as the Creators page shows it, newest joiner first: name, email, status, handles and followers per platform with any open account alert, groups, trial dates, and all-time videos and views. By default archived creators are left out, as in the app; pass `status=archived` for them. Filter with `status`, `groupIds` and `search`. Pay (payouts, CPM, base pay, bonus deals) is in the payout operations (`payouts:read`), e.g. GET /brands/{brandId}/creators/{creatorId}/pay.

Funds balance and recent activity GET

The brand's balance for paying creators on the platform-managed payout provider, and its latest 25 ledger entries, as on the funds card in Settings › Integrations. Read from Bloss's own ledger; nothing here opens a payment. `available: false` when this deployment has no platform-managed provider.