Bloss Docs

Get the brand

Developers
GET
/brands/{brandId}

The brand's name, slug, plan, time zone, branding and program settings as Settings shows them: the creator trial, posting cadence per platform, whether brand-wide stats are hidden from creators, and which features are on. Pay rules (base pay, bonus tiers, payout model) are not here; they need the payouts permission. Calendar days elsewhere in the Brand API are in timeZone.

Authorization

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

Path Parameters

brandId*string

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

Length1 <= length

Response Body

Success.

application/json
  1. response
id*string
name*string
slug*string
url*string

The brand's admin area.

plan*|

The plan the brand's features come from.

timeZone*string

IANA time zone. Days, weeks and cycles are counted in it.

branding*
trial*
postingCadence*array<>

The posting rules creators are checked against, one per platform.

hideStatsFromCreators*boolean

Brand-wide charts, leaderboards and team tables are hidden from creators.

features*
curl -X GET 'https://example.com/api/v1/brands/string'
{  "id": "string",  "name": "string",  "slug": "string",  "url": "string",  "plan": {    "key": "string",    "name": "string"  },  "timeZone": "string",  "branding": {    "hasLogo": true,    "primaryColor": "string",    "accentColor": "string",    "secondaryColor": "string",    "chartColors": [      "string"    ]  },  "trial": {    "enabled": true,    "days": 0,    "viewGoal": 0,    "videoGoal": 0  },  "postingCadence": [    {      "platform": "instagram",      "minPerWeek": 0,      "maxPerDay": 0,      "enforced": true,      "source": "default"    }  ],  "hideStatsFromCreators": true,  "features": {    "bounties": true,    "streakSurvivors": true,    "videoTracking": true,    "shareVideoVault": true,    "shareTagAnalytics": true  }}

Was this page helpful?

The brand's Streak Survivor games GET

Every Streak Survivor game, newest first, as the Streak Survivor page lists them (status "pending", "active" or "ended", prize pool, lives, posts required per day, current day), each with its standings: every participant's lives, streaks, posts and whether and when they were eliminated, survivors first.

The brand's creator groups GET

The brand's creator groups in display order, each with exactly which creators are in it. Membership is current, and includes archived creators (their past sets still count in reports). Use a group id, or "__ungrouped__" for creators in no group, in the `groupIds` filter of GET /brands/{brandId}/creators.