Bloss Docs

List onboarding submissions

Developers
GET
/brands/{brandId}/onboarding/submissions

One row per creator going through an onboarding flow, finished or not, most recent activity first, as on Onboarding › Submissions. Filter by flow, link, current task, status (overdue is in progress with a task past its deadline), start day (brand time zone) and name, email or Discord. Set withAnswers to "true" to add each creator's form answers and agreement signatures (at most 25 per page); GET .../submissions/{submissionId} has one in full.

Authorization

bearerAuth onboarding: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: onboarding: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
flowId?string

An id from GET .../onboarding/flows.

Length1 <= length
linkId?string

Only creators who started from this invite link.

Length1 <= length
taskId?string

Only submissions whose current task is this one.

Length1 <= length
status?string

Only submissions in this state. Default: all.

Value in"in_progress""overdue""awaiting_approval""joined""rejected""closed"
startedFrom?string

Started on or after this day, YYYY-MM-DD in the brand's time zone.

startedTo?string

Started on or before this day, YYYY-MM-DD in the brand's time zone.

search?string

Part of the creator's name, email or Discord username.

Lengthlength <= 200
withAnswers?string

"true" adds answers and signatures to each row, with at most 25 rows a page. Default false.

Value in"true""false"

Response Body

Success.

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

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

total*number

Submissions matching, across all pages.

curl -X GET 'https://example.com/api/v1/brands/string/onboarding/submissions'
{  "data": [    {      "id": "string",      "status": "string",      "overdue": true,      "flow": {        "id": "string",        "name": "string"      },      "link": {        "id": "string",        "label": "string"      },      "viaEmailInvite": true,      "creator": {        "name": "string",        "email": "string",        "discordUsername": "string",        "creatorId": "string"      },      "currentTask": {        "id": "string",        "title": "string"      },      "tasks": [        {          "id": "string",          "title": "string",          "kind": "form",          "status": "string",          "dueAt": "string"        }      ],      "startedAt": "string",      "lastActivityAt": "string",      "completedAt": "string",      "decidedAt": "string",      "answers": [        {          "taskId": "string",          "task": "string",          "fieldId": "string",          "field": "string",          "value": "string",          "submitted": true        }      ],      "signatures": [        {          "taskId": "string",          "task": "string",          "signerName": "string",          "signerEmail": "string",          "kind": "string",          "signedAt": "string",          "documentSha256": "string",          "hasSignedPdf": true        }      ]    }  ],  "nextCursor": "string",  "total": 0}

Was this page helpful?