Bloss Docs

List your students

Developers
GET
/coach/students

Your roster as the coach console shows it, newest student first: stage, tags, active deals, brand-post views, last brand post, cash collected and the quiet/stalled flags. Brand work only, never the student's personal content. Filter by stageId (or none for unstaged students).

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

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
stageId?string

Only students in this stage (an id from GET /coach/stages), or "none" for unstaged.

Length1 <= length

Response Body

Success.

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

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

noPostsThresholdDays*number

The days without a brand post that make a student read as quiet.

curl -X GET 'https://example.com/api/v1/coach/students'
{  "data": [    {      "creatorId": "string",      "creatorSlug": "string",      "displayName": "string",      "avatarUrl": "string",      "joinedAt": "string",      "tags": [        "string"      ],      "stage": {        "id": "string",        "name": "string",        "color": "zinc"      },      "activeDeals": 0,      "totalDealsAllTime": 0,      "views7d": 0,      "views30d": 0,      "lastPostedAt": "string",      "cashCollectedAllTime": 0,      "cashCollectedThisMonth": 0,      "noRecentPosts": true,      "isStalled": true    }  ],  "nextCursor": "string",  "noPostsThresholdDays": 0}

Was this page helpful?