Bloss Docs

You in one brand

Developers
GET
/creator/brands/{brandId}

What your dashboard in a brand shows about you: your status and join date, connected socials (with any account alerts), trial progress, the current cycle and your views, engagement and videos in it, and the brand's posting rules. Earnings are not included; read them with the earnings endpoints.

Authorization

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

Path Parameters

brandId*string

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

Length1 <= length

Response Body

Success.

application/json
  1. response
brand*
creator*
trial*|

Set while your status is trial.

currentCycle*|null
currentCycleStats*|

Your numbers in the current cycle; null when no cycle is running.

postingRules*
curl -X GET 'https://example.com/api/v1/creator/brands/string'
{  "brand": {    "id": "string",    "name": "string",    "slug": "string",    "timeZone": "string"  },  "creator": {    "id": "string",    "status": "string",    "joinedAt": "string",    "noteFromBrand": "string",    "socials": [      {        "platform": "instagram",        "handle": "string",        "connected": true,        "followers": 0,        "alert": {          "kind": "string",          "detectedHandle": "string",          "detectedAt": "string"        }      }    ]  },  "trial": {    "enabled": true,    "inTrial": true,    "completed": true,    "skipped": true,    "qualifyingVideos": 0,    "videoGoal": 0,    "viewGoal": 0,    "videosRemaining": 0,    "progressPercent": 0,    "totalViews": 0,    "totalVideos": 0,    "daysRemaining": 0,    "trialDays": 0,    "startsAt": "string",    "endsAt": "string"  },  "currentCycle": {    "id": "string",    "startsAt": "string",    "endsAt": "string",    "startDay": "string",    "endDay": "string"  },  "currentCycleStats": {    "views": 0,    "likes": 0,    "comments": 0,    "shares": 0,    "videosPosted": 0,    "engagementRate": 0,    "byPlatform": {      "instagram": {        "videos": 0,        "views": 0      },      "tiktok": {        "videos": 0,        "views": 0      },      "youtube": {        "videos": 0,        "views": 0      },      "facebook": {        "videos": 0,        "views": 0      }    }  },  "postingRules": {    "timeZone": "string",    "cycleDurationDays": 0,    "minVideosPerWeek": 0,    "maxVideosPerDay": 0,    "minimumViewsPerVideo": 0,    "thresholdMode": "all",    "platformRequirement": "all",    "trial": {      "enabled": true,      "videoGoal": 0,      "viewGoal": 0,      "days": 0    },    "bountiesEnabled": true,    "streakSurvivorsEnabled": true,    "referralProgramEnabled": true  }}

Was this page helpful?

Streak Survivor in a brand GET

The brand's active Streak Survivor game, if any (prize pool, day, lives, posts required per day) with your own standing in it, and the past games. As on your Streak Survivor page.

Your payout setup in a brand GET

Where this brand pays you: its payout provider, whether your account there is set up, and your PayPal details, as in Payout Settings on your dashboard. Emails and account ids are masked. Balances aren't included: reading one can open a wallet, and this API never changes anything.