/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog
API Reference Get Onboarding

Get Onboarding

Where you are in setting up your account: verify email, about you, first project, first publish.

GET/v1/me/onboardingTry it
Session token

Returns your progress through the dashboard's setup flow — Verify email → About you → Create project → Publish — and your About you answers. The dashboard uses it to decide whether to send you to /onboarding.

Note

Requires a session JWT — a dashboard session or an stx login token. API keys are rejected with 401. Any plan.

Nothing here is stored as progress. Every step is worked out from your account each time you ask:

StepidDone whenSkippable
Verify emailverifyYour email address is verifiedNo
About youprofileYou answered or skipped the questionsYes
Create projectprojectA workspace you belong to has a project that isn't deletedNo
PublishpublishOne of those projects has a production build that deployed — previews don't countNo

So a project created in the CLI, or a workspace you were invited to that already has one, counts.

Response — 200 OK

NameDescription
required:booleanbody
true while Verify email or Create project isn't done. The dashboard keeps you in the setup flow until it's false; About you and Publish don't hold you there.
steps:arraybody
The four steps, always in the order verify, profile, project, publish. Each has id, status and skippable.
steps[].status:stringbody
done, current — the first step that isn't done — or todo for the steps after it. Every step can be done while an earlier one isn't: publishing before you verify still marks publish done.
steps[].skippable:booleanbody
Only profile is skippable.
answers:object | nullbody
Your About you answers, in the shape Save Onboarding Answers takes, with heardFrom as null when you left it blank. null when you skipped the questions or haven't answered yet.

Error Responses

401 Unauthorized

unauthorized for a missing, invalid or expired token (or an API key); session_revoked when the session has been signed out.

Was this page helpful? Yes No
Request
cURLJavaScriptPythonGoRubyPHPJavaC#cURL
curl https://api.syntext.dev/v1/me/onboarding \
-H "Authorization: Bearer $SYNTEXT_JWT"
Responseapplication/json
200OK
{
"data": {
"required": true,
"steps": [
{ "id": "verify", "status": "done", "skippable": false },
{ "id": "profile", "status": "done", "skippable": true },
{ "id": "project", "status": "current", "skippable": false },
{ "id": "publish", "status": "todo", "skippable": false }
],
"answers": {
"documenting": ["help_center", "api_docs"],
"role": "engineer",
"teamSize": "2_10",
"heardFrom": null
}
}
}
Product
Resources
Company
© 2026 SyntextBuilt with Syntext