Bloss Docs

List onboarding flows

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

The brand's onboarding flows, as on Onboarding › Flows: each flow's tasks in order, its join group, its invite links with their sign-up URLs and the group each one places joiners in, and how many creators are in it or joined through it. Task and link ids filter GET .../onboarding/submissions.

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

Response Body

Success.

application/json
  1. response
data*array<>
curl -X GET 'https://example.com/api/v1/brands/string/onboarding/flows'
{  "data": [    {      "id": "string",      "name": "string",      "status": "string",      "completionMode": "string",      "preJoinVideosIrrelevant": true,      "joinGroup": {        "id": "string",        "name": "string"      },      "tasks": [        {          "id": "string",          "title": "string",          "kind": "form",          "deadlineHours": 0,          "agreementId": "string"        }      ],      "links": [        {          "id": "string",          "url": "string",          "label": "string",          "active": true,          "uses": 0,          "maxUses": 0,          "expiresAt": "string",          "group": {            "id": "string",            "name": "string"          },          "effectiveGroup": {            "id": "string",            "name": "string",            "source": "flow"          }        }      ],      "openSubmissions": 0,      "joined": 0,      "updatedAt": "string"    }  ]}

Was this page helpful?

Create an onboarding flow POST

Create a draft flow, not live yet. Blank, it has one form task with an empty form. With `template: true` it's the "3-task onboarding" template: two starter forms and an empty agreement (named "3-task onboarding"; `name` is ignored). Returns the flow as brand.onboarding.flow.get does. To build a flow: create it (brand.onboarding.flows.create), add a form for each form task (brand.onboarding.flow.forms.create) and write its questions (brand.onboarding.form.update), write agreements (brand.onboarding.agreements.create), set the tasks and settings (brand.onboarding.flow.draft.update), then publish with goLive (brand.onboarding.flow.publish).

Get a form's draft and versions GET

One onboarding form: its draft definition (sections and questions) with its revision, the live version creators fill in, its published versions, and what blocks publishing it. Read this before changing the form.