Skip to content

Invites

Previewing and accepting a workspace invitation.

GET /api/public/invites/{token}

Preview an invitation

Unauthenticated

Callable with no credential.

States what accepting would grant, which workspace it joins, and whether the inviter may still invite — an invitation must not outlive the authority that issued it. The response carries the server's own claim too, so the recipient can verify the domain before handing over an account.

features lists the parts of the app the invite starts a member on (labelled, as in GET /api/features), or is null when the invite leaves that choice to the person.

Parameters

Name In Required Notes
token path yes

Responses

Status Meaning
200 What this invitation grants.
404 No such resource, or the caller may not see it.

POST /api/public/invites/{token}

Accept an invitation

Auth: Session

Joins the workspace with the invite's permissions. If the invite carries a starting feature set and the account has never chosen one, that set becomes the account's; a set the person chose themselves is never overwritten. The answer's features is what the account sees afterwards.

Parameters

Name In Required Notes
token path yes

Responses

Status Meaning
200 Joined.
401 Refused, with a named reason.