/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog
API Reference Sign In with GitHub

Sign In with GitHub

Start GitHub sign-in or sign-up: a browser redirect to GitHub and back to the dashboard.

GET/v1/auth/githubTry it
Session token

Starts Continue with GitHub. This is a browser flow, not a JSON endpoint: open the URL in the browser, and it redirects to GitHub, then back through GET /v1/auth/github/callback to the dashboard, signed in. If no Syntext account matches the GitHub account, one is created along with a personal workspace.

Note

Public — no credential needed. Any plan. To connect GitHub to an account you're already signed in to, use GET /v1/auth/github/link instead.

Query Parameters

All optional. A sign-up form sends what the person chose; they're carried through GitHub in the signed OAuth state and applied only if the sign-in creates an account (except timezone, which also updates an existing account). Invalid values are dropped, never an error.

NameDescription
acceptedTerms:stringquery
true or false — the Terms of Service and Privacy Policy box. Recorded only together with termsVersion.
termsVersion:stringquery
The version of the Terms the form showed, 1–64 letters, digits, ., _ or -.
marketingConsent:stringquery
true or false — the optional marketing box. Stored under the same regional rule as Register.
timezone:stringquery
The browser's IANA timezone, e.g. Europe/Berlin.
country:stringquery
The browser's ISO 3166-1 alpha-2 country code, e.g. DE.
text
https://api.syntext.dev/v1/auth/github?acceptedTerms=true&termsVersion=2026-11-01&marketingConsent=false&timezone=Europe%2FBerlin&country=DE

GitHub permissions

Syntext reads your GitHub email addresses (GET /user/emails) and uses your primary verified address, or your first verified address if the primary isn't verified, even when it's private on your GitHub profile. Because GitHub has already verified it, your Syntext account is verified straight away. The first time you sign in after this change, GitHub asks you once to approve email access.

Syntext never uses a @users.noreply.github.com address while you have a real verified one. If Syntext can't read your addresses, it uses your public GitHub profile email, unverified — ask for a verification email from the setup guide (or Send Verification Email). If that's private too, the account gets a placeholder address that receives no mail: set a real one with Change email in the setup guide or your profile. Syntext never sends email to a noreply address.

Account email on later sign-ins

An account created earlier with a noreply address, or with an unverified address, switches to your GitHub verified address the next time you sign in with GitHub, and is marked verified. The change is recorded in your workspace audit log as user.email_changed. An account whose email is already verified keeps it. If another Syntext account already uses the address, nothing changes and the accounts are not merged.

Which account you sign in to

1.
An account already connected to this GitHub login signs straight in.
2.
Otherwise, an account with the same email — your public GitHub email or your verified primary address — is connected and signed in, but only if that account has verified its email address.
3.
Otherwise, a new account is created.

If the matching account hasn't verified its email, sign-in is refused and the browser lands on the dashboard's /login?error=email_in_use. Sign in with that account's password, verify the address, and connect GitHub from settings.

When the account you sign in to hasn't verified its email, and its address is your GitHub verified primary address, signing in with GitHub verifies it — so it skips the dashboard's Verify email step.

Warning

Before this change, GitHub sign-in connected any account with a matching email, verified or not. Someone who registered your address first, without access to its inbox, could have had your GitHub sign-in land in their account. Only verified accounts are connected now.

Terms acceptance

Today a GitHub sign-up goes ahead without acceptedTerms, and an acceptance is recorded when the form sends one. Once the Terms requirement is switched on, a GitHub sign-up without acceptedTerms=true and a termsVersion is refused and lands on /register?error=terms_required. Signing in to an existing account is never affected.

Redirects

OutcomeThe browser lands on
Signed in/auth/github/callback?token=…&refresh_token=…&orgId=… in the dashboard
Email belongs to an unverified account/login?error=email_in_use
Sign-up without the Terms, once required/register?error=terms_required
GitHub sign-in failed/login?error=github_failed

A callback without code or state, or with a used, expired or forged state, returns a 400 JSON error instead.

Was this page helpful? Yes No
Request
cURLJavaScriptPythonGoRubyPHPJavaC#cURL
curl --request GET \
--url 'https://api.syntext.dev/v1/auth/github' \
--header 'Authorization: Bearer <jwt>'
Product
Resources
Company
© 2026 SyntextBuilt with Syntext