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

Get Profile

Your account profile, with emailVerified and onboardingRequired.

GET/v1/auth/profileTry it
Session token

Returns your account profile: name, email, avatar and GitHub username, plus whether your email is verified and whether setup is still required.

Note

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

The response is the same as Get Session User.

Response — 200 OK

NameDescription
emailVerified:booleanbody
true once the address has been verified. See Email verification.
onboardingRequired:booleanbody
true while the email isn't verified, or no workspace you belong to has a project yet — see Get Onboarding.

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.

404 Not Found

not_found — the account no longer exists.

Was this page helpful? Yes No
Request
cURLJavaScriptPythonGoRubyPHPJavaC#cURL
curl https://api.syntext.dev/v1/auth/profile \
-H "Authorization: Bearer $SYNTEXT_JWT"
Responseapplication/json
200OK
{
"data": {
"id": "0b7e4c2d-9a1f-4d3e-8c56-2f1a7b9e0d48",
"email": "alex@example.com",
"name": "Alex Rivera",
"avatarUrl": null,
"githubUsername": null,
"createdAt": "2026-11-14T09:02:11.000Z",
"emailVerified": false,
"onboardingRequired": true
}
}
Product
Resources
Company
© 2026 SyntextBuilt with Syntext