Skip to main content
GET
Get a creator's onboarding

Authorizations

x-api-key
string
header
required

API key created in Dashboard → Settings → Developer

Path Parameters

creatorId
string
required

Opaque creator id returned by /creators

Query Parameters

scope
enum<string>
default:company

Choose the data scope. company (default) limits results to the API key company's data. agency includes the parent agency and its linked brands. scope=agency requires a parent agency key; other keys receive 403.

Available options:
company,
agency
programId
string<uuid>
required

Response

Creator onboarding returned successfully

programId
string<uuid>
required
creatorId
string
required
status
enum<string>
required

waiting_for_review: a proof waits for your decision. getting_ready: the creator still has to do something. ready: nothing is left (detail only).

Available options:
waiting_for_review,
getting_ready,
ready
canPost
boolean
required

The creator may post in the program now

pendingProofCount
integer
required
requiredPlatforms
string[]
required

Platforms the program requires an account on

missingPlatforms
string[]
required

Required platforms without a ready account

warmUp
object
required
accounts
object[]
required

The creator's accounts linked to the program

requirementsWithoutAccount
object[]
required

Custom requirements the creator cannot meet yet because no linked account is on their platforms

checklist
object[]
required

The program's onboarding checklist items for the creator