Bloss Docs

List the brand's creators

Developers
GET
/brands/{brandId}/creators

The roster as the Creators page shows it, newest joiner first: name, email, status, handles and followers per platform with any open account alert, groups, trial dates, and all-time videos and views. By default archived creators are left out, as in the app; pass status=archived for them. Filter with status, groupIds and search. Pay (payouts, CPM, base pay, bonus deals) is in the payout operations (payouts:read), e.g. GET /brands/{brandId}/creators/{creatorId}/pay.

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, recruitment:read, engagement:read, support:read, integrations:read, payouts:read, funds:read, billing:read.

Scope: creators:read

Path Parameters

brandId*string

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

Length1 <= length

Query Parameters

limit?integer

Page size, 1–100. Default 50.

Range1 <= value <= 100
Default50
cursor?string

The nextCursor from the previous page. Omit for the first page.

Length1 <= length
status?string

Only creators with this status. Default: everyone except archived.

Value in"trial""active""paused""archived"
groupIds?string

Comma-separated group ids (GET .../creator-groups): creators in ANY of them. "ungrouped" matches creators in no group.

Length1 <= length
search?string

Case-insensitive match on name, email or any handle.

Length1 <= length
updatedSince?string

Only creators whose record changed at or after this time.

Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
Formatdate-time

Response Body

Success.

application/json
  1. response
data*array<>
nextCursor*|

Pass as cursor to get the next page; null on the last page.

curl -X GET 'https://example.com/api/v1/brands/string/creators'
{  "data": [    {      "id": "string",      "name": "string",      "email": "string",      "avatarUrl": "string",      "status": "trial",      "joinedAt": "string",      "updatedAt": "string",      "lastSyncAt": "string",      "trial": {        "startedAt": "string",        "endsAt": "string"      },      "socials": {        "instagram": {          "handle": "string",          "connected": true,          "followers": 0,          "alert": {            "kind": "handle_changed",            "detectedHandle": "string",            "detectedAt": "string"          }        },        "tiktok": {          "handle": "string",          "connected": true,          "followers": 0,          "alert": {            "kind": "handle_changed",            "detectedHandle": "string",            "detectedAt": "string"          }        },        "youtube": {          "handle": "string",          "connected": true,          "followers": 0,          "alert": {            "kind": "handle_changed",            "detectedHandle": "string",            "detectedAt": "string"          }        },        "facebook": {          "handle": "string",          "connected": true,          "followers": 0,          "alert": {            "kind": "handle_changed",            "detectedHandle": "string",            "detectedAt": "string"          }        }      },      "groupIds": [        "string"      ],      "hasOpenAlert": true,      "stats": {        "videos": 0,        "views": 0,        "viewsByPlatform": {          "instagram": 0,          "tiktok": 0,          "youtube": 0,          "facebook": 0        }      }    }  ],  "nextCursor": "string"}

Was this page helpful?