Docs
OverviewGuidesZero & MCPAPI referenceChangelog
Invites

Preview Invite

What an invite link offers (workspace, role, inviter), for the accept page. No authentication. An unknown, used, revoked or expired link is the same 404. Rate-limited per client IP (`INVITE_RATE_LIMIT_ATTEMPTS`, 429 with `Retry-After`).

API key access

This route has its own authentication (or none); an API key is not used here.
GET/api/v1/invites/{token}

Path Parameters

tokenstring

Response Body

curl -X GET "http://localhost:8000/api/v1/invites/string"
{
  "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
  "workspace_name": "string",
  "role": "owner",
  "email_hint": "string",
  "invited_by": "string",
  "expires_at": "2019-08-24T14:15:22Z"
}
Empty
Empty

Accept Invite

Join the invite's workspace with its role (signed-in users; an API key gets 403). The invite is used up. 409 if you're already a member (the invite stays open). Rate-limited like the preview. To sign up and join in one step, send `invite_token` to `/auth/signup`.

Delete Document

Next Page