Bloss Docs

Get one student

Developers
GET
/coach/students/{creatorId}

One student's page in the coach workspace: profile, stage, the KPI strip (active deals, cash collected, last brand post), the brands they create for with their handles, their deals, and their 24 most recent brand posts grouped into pairs.

Authorization

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

Path Parameters

creatorId*string

A student's creator id from GET /coach/students.

Length1 <= length

Response Body

Success.

application/json
  1. response
creator*
joinedAt*string
tags*array<string>
stage*|

The stage you put the student in, or null.

stats*
brands*array<>

The brands the student creates for, with the handles they post from in each.

deals*array<>

Each brand payout cycle the student has posted into.

recentPairs*array<>

The student's 24 most recent brand posts, grouped into pairs.

curl -X GET 'https://example.com/api/v1/coach/students/string'
{  "creator": {    "id": "string",    "slug": "string",    "displayName": "string",    "bio": "string",    "avatarUrl": "string"  },  "joinedAt": "string",  "tags": [    "string"  ],  "stage": {    "id": "string",    "name": "string",    "color": "zinc"  },  "stats": {    "activeDeals": 0,    "cashCollectedAllTime": 0,    "cashCollectedThisMonth": 0,    "lastBrandPostAt": "string",    "viewsRecentPairs": 0  },  "brands": [    {      "brandId": "string",      "brandName": "string",      "brandSlug": "string",      "status": "string",      "instagramUsername": "string",      "instagramFollowers": 0,      "tiktokUsername": "string",      "tiktokFollowers": 0,      "youtubeUsername": "string",      "youtubeFollowers": 0,      "facebookPageUrl": "string",      "facebookFollowers": 0    }  ],  "deals": [    {      "brandId": "string",      "brandName": "string",      "startsAt": "string",      "endsAt": "string",      "status": "active",      "videoCount": 0,      "paidAmount": 0    }  ],  "recentPairs": [    {      "pairId": "string",      "brand": {        "id": "string",        "name": "string",        "slug": "string"      },      "isPaired": true,      "videoCount": 0,      "pairedAt": "string",      "firstVideoAt": "string",      "totalPay": 0,      "ledgerStatus": "string",      "videos": [        {          "id": "string",          "platform": "string",          "url": "string",          "caption": "string",          "postedAt": "string",          "views": 0,          "likes": 0,          "comments": 0,          "isWinner": true        }      ]    }  ]}

Was this page helpful?