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

Get Session User

Who is signed in, whether their email is verified, and whether setup is still required.

GET/v1/auth/meTry it
Session token

Returns the signed-in person, with two flags a client can route on: whether their email address is verified, and whether the dashboard's setup flow still needs them.

Note

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

Get Profile returns the same fields. For each step of setup, use Get Onboarding.

Response — 200 OK

NameDescription
emailVerified:booleanbody
true once the address has been verified — through the emailed link, by accepting an invitation sent to it, or by signing in with GitHub when it's your GitHub verified primary address. See Email verification.
onboardingRequired:booleanbody
true while the email isn't verified, or no workspace you belong to has a project yet. It's the same answer as required on 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 has been deleted.

Was this page helpful? Yes No
Request
cURLJavaScriptPythonGoRubyPHPJavaC#cURL
curl https://api.syntext.dev/v1/auth/me \
-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": "alexr",
"createdAt": "2026-11-14T09:02:11.000Z",
"emailVerified": true,
"onboardingRequired": false
}
}
Product
Resources
Company
© 2026 SyntextBuilt with Syntext