Bloss Docs

Get one creator group

Developers
GET
/brands/{brandId}/creator-groups/{groupId}

One creator group: its members (archived creators included), whether it sets pay, and joinSources, the onboarding flows and invite links that add new joiners to it. A link places joiners in its flow's join group whenever the flow sets one, and in its own group only when the flow sets none. The pay rates are at GET .../creator-groups/{groupId}/pay (payouts:read).

Authorization

bearerAuth creators: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, onboarding:read, onboarding:signatures, engagement:read, support:read, integrations:read, payouts:read, funds:read, billing:read, groups:write, videos:write, onboarding:write, sync:write, payouts:write.

Scope: creators:read

Path Parameters

brandId*string

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

Length1 <= length
groupId*string

A group id from GET /brands/{brandId}/creator-groups.

Length1 <= length

Response Body

Success.

application/json
  1. response
id*string
name*string
color*|

A colour token name, or null.

sortOrder*number
memberCount*number
creatorIds*array<string>
setsPay*boolean

The group sets some pay for its members: a base rate, a bonus or a minimum-views threshold. The rates are at GET .../creator-groups/{groupId}/pay (payouts:read).

updatedAt*string

When the group's own settings (name, colour, order, pay) last changed. Adding or removing members doesn't change it.

joinSources*

Where new members come from.

curl -X GET 'https://example.com/api/v1/brands/string/creator-groups/string'
{  "id": "string",  "name": "string",  "color": "string",  "sortOrder": 0,  "memberCount": 0,  "creatorIds": [    "string"  ],  "setsPay": true,  "updatedAt": "string",  "joinSources": {    "flows": [      {        "id": "string",        "name": "string",        "status": "string"      }    ],    "links": [      {        "code": "string",        "label": "string",        "active": true,        "flow": {          "id": "string",          "name": "string"        },        "source": "flow"      }    ]  }}

Was this page helpful?

Get the brand GET

The brand's name, slug, plan, whether it has the Brand API, 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`. The Brand API check is cached for up to 60 seconds, so after a plan change, retry a `plan_required` error after a minute.

A creator group's pay GET

The pay a creator group sets for its members, as in the group's pay dialog on the Creators page: base pay per set (one rate or per platform), a bonus (view tiers or a rate per 1,000 views with an optional cap) and a minimum-views threshold. A null field isn't set by the group, so the brand's rule applies (shown in `brandDefaults`). A creator's own deal wins over their group's; a creator in several pay-setting groups gets each field from the highest group in the brand's group order. Also how many members the group's pay doesn't fully reach, and whether a payment in flight locks it. Change it with brand.group.pay.update.