Skip to main content
GET
Read the onboarding state

Authorizations

Authorization
string
header
required

Clerk API key. Create one in Settings → API Keys. Pass as Authorization: Bearer <key>. Keys carry a scope — read, write (implies read) or admin (implies write) — chosen when the key is minted. Each operation's security requirement (and its x-required-scope extension) names the minimum scope it needs; request the least-privileged key that covers the operations you call.

Response

200 response

step
enum<string>
required

Where the onboarding is: account → website → keywords → mentions → feeds → slack → mcp → complete.

Available options:
account,
website,
keywords,
mentions,
feeds,
slack,
mcp,
complete
status
enum<string>
required

needs_input = a decision or value is wanted · running = server work in flight, poll · needs_human = a person must act (open a link, read an email) · pending_review = the workspace waits for manual review · done = nothing left to do.

Available options:
needs_input,
running,
needs_human,
pending_review,
done
revision
string
required

Hash of the onboarding timestamps, the draft's updatedAt and the marker's tail (--if-revision).

engine
enum<string>
required
Available options:
sonar,
classic
handle
object
required
completed
enum<string>[]
required

Where the onboarding is: account → website → keywords → mentions → feeds → slack → mcp → complete.

Available options:
account,
website,
keywords,
mentions,
feeds,
slack,
mcp,
complete
reviewed
boolean
required

True after manual review approved the workspace (the post-review tail).

pendingReview
boolean
required
trial
object | null
required

Null until the workspace exists (keywords confirmed).

view
object
required

The current step's section is set; the others may be null.

next
object | null
required

Null when status is done.