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

Get Invitation

Look up an invitation by its token to show the invite page.

GET/v1/invites/{token}Try it

Returns what an invitation is for — the workspace, the role, who sent it — so the invitee can decide whether to accept. While the invitation is open it also includes a summary of the workspace.

Note

Public — no credential needed. The invitee may not have an account yet; the token from the invitation email is what grants access. Any plan.

Because invitation links get forwarded, this endpoint shares counts only. It never returns the names of the workspace's members.

Path Parameters

NameDescription
token:stringpathRequired
The invitation token from the link in the invitation email.

Response — 200 OK

NameDescription
status:stringbody
pending, accepted, declined, revoked or expired.
expired:booleanbody
true once expiresAt has passed, even if status still says pending.
inviterName:stringbody
The inviter's name, or "A team member" when it isn't known.
inviterEmail:stringbody
The inviter's email address. Only while the invitation is open.
inviterRole:stringbody
The inviter's current role in the workspace. Only while the invitation is open, and omitted if the inviter has left.
team:objectbody
Only while the invitation is open. projects counts the workspace's live projects, pages adds up the pages in each project's latest production deploy, and memberCount counts members. members is always an empty array — names are not shared.

An invitation is open while its status is pending and it hasn't expired. Accepted, declined, revoked and expired invitations return only the base fields, without inviterEmail, inviterRole or team.

Error Responses

404 Not Found

not_found — no invitation has this token. A resent invitation gets a new token, so the link in an earlier email returns 404.

json
{
"error": {
"code": "not_found",
"message": "Invitation not found",
"details": { "traceId": "6f1c2a9e-3b7d-4c11-9a0e-2d5f8b4c7e10" }
}
}
Was this page helpful? Yes No
Request
cURLJavaScriptPythonGoRubyPHPJavaC#cURL
curl https://api.syntext.dev/v1/invites/4e7a9c1b-3d5f-4a8c-b2e4-6f8a0c2e4b67
Responseapplication/json
200OK
{
"data": {
"email": "alex@example.com",
"role": "member",
"orgName": "Acme",
"inviterName": "Jane Doe",
"inviterAvatar": "https://api.syntext.dev/v1/auth/avatars/0b7e4c2d-9a1f-4d3e-8c56-2f1a7b9e0d48/5a9e3c71-2b4d-4f8a-9c06-e1d7b3a2f584.png",
"status": "pending",
"expired": false,
"expiresAt": "2026-11-15T10:00:00.000Z",
"inviterEmail": "jane@example.com",
"inviterRole": "owner",
"team": {
"projects": 3,
"pages": 142,
"memberCount": 4,
"members": []
}
}
}
Product
Resources
Company
© 2026 SyntextBuilt with Syntext