Bloss Docs

Referral payouts

Developers
GET
/brands/{brandId}/referral-payouts

Referral bonuses owed or paid to creators whose invite code brought in another creator, newest first, as on the Referral Payouts page.

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

Response Body

Success.

application/json
  1. response
data*array<>
curl -X GET 'https://example.com/api/v1/brands/string/referral-payouts'
{  "data": [    {      "id": "string",      "amount": 0,      "status": "pending",      "referrer": {        "id": "string",        "name": "string",        "paypalEmail": "string"      },      "referredCreator": {        "id": "string",        "name": "string"      },      "createdAt": "string",      "paidAt": "string"    }  ]}

Was this page helpful?