Manual
CLI
API
Log in Get started free

Show an invite

Returns what an invitation to an organisation is for, so you can show it before it is accepted.

Returns what an invitation to an organisation is for, so you can show it before it is accepted.

HTTP
GET /auth/invites/{token}

Access: No token needed.

Path parameters #

ParameterDescription
tokenThe token from the invitation link.

Response 200 #

The invitation.

JSON
{
  "email": "grace@example.com",
  "organization": "Acme",
  "role": "member"
}

Response fields #

FieldTypeDescription
emailstringThe address the invitation was sent to.
organizationstringThe name of the organisation.
rolestringThe role the invited person gets in the organisation.

Errors #

StatuserrorWhen
410invalid_or_expired_tokenThe token is unknown or has expired.
429rate_limitedToo many requests, see Rate limiting.

See Errors for the error format.