Bloss Docs

Get an onboarding submission

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

One creator's onboarding: every task with its answers as text (labelled as the creator saw them; answers on open tasks are autosaved drafts), agreement signatures (who signed, when, the document hash), and any rejection or close reason. The signature image and signed PDF are at GET .../signatures, with the Signed agreements permission.

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
submissionId*string

An id from GET /brands/{brandId}/onboarding/submissions.

Length1 <= length

Response Body

Success.

application/json
  1. response
id*string
status*string

"in_progress", "awaiting_approval", "joined", "rejected" or "closed". "admitting" for the few seconds a creator is being added to the roster.

overdue*boolean

In progress with an open task past its deadline.

flow*
link*|

The invite link the creator started from. Null for email invites.

viaEmailInvite*boolean
creator*
currentTask*|null
tasks*array<>
startedAt*string
lastActivityAt*string
completedAt*|

When the last task was finished.

decidedAt*|

When the creator joined, or the submission was rejected or closed.

rejectionReason*string|null
closedReason*string|null
answers*array<>

Answered questions only, in form order.

signatures*array<>
curl -X GET 'https://example.com/api/v1/brands/string/onboarding/submissions/string'
{  "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",      "submittedAt": "string",      "changesNote": "string"    }  ],  "startedAt": "string",  "lastActivityAt": "string",  "completedAt": "string",  "decidedAt": "string",  "rejectionReason": "string",  "closedReason": "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    }  ]}

Was this page helpful?

Move a task's deadline POST

Set a new deadline for an open task of a submission in progress. Send exactly one of: `addHours` (1–1440, added to the current deadline, or to now if it has passed), `dueAt` (an ISO-8601 instant), or `date` and `time` (the brand's time zone). It must be in the future. The due-soon and overdue emails are sent again for the new deadline.

Reject a submission POST

Reject an open submission (in progress or awaiting approval). The creator doesn't join, and is emailed, with the reason if you give one. A closed or decided submission answers 409 conflict.