Bloss Docs

List creator groups and their members

Developers
GET
/groups

Your brand's creator groups — the same groups you filter the Video Vault and the roster by — each with the ids of the creators in it. Use a returned groupId as groupIds on GET /campaign/pairs, or join creatorIds against the creator.creatorId on each pair.

Groups are a property of the roster, not of a campaign, so this is not scoped to cycles. Membership is current, not historical: there is no record of when a creator joined or left a group, so re-running a report over an older cycle groups its pairs the way the roster looks today.

Archived creators are included — their pairs stay in their cycles and keep appearing in the campaign endpoints. Empty groups come back with creatorIds: []. Groups are returned in your brand's own display order.

Authorization

headerAuthorizationBearer <token>

Provide your API key as Authorization: Bearer <key>.

Response Body

The brand's groups and their membership.

application/json
  1. response
groups?array<>
ungroupedFilterId?string

The sentinel to pass in groupIds for "creators in no group at all". Not a real group; it never appears in groups.

curl -X GET 'https://example.com/api/v0/groups'
{  "groups": [    {      "groupId": "string",      "name": "string",      "color": "string",      "sortOrder": 0,      "memberCount": 0,      "creatorIds": [        "string"      ]    }  ],  "ungroupedFilterId": "string"}

Was this page helpful?