Skip to content

Look up an invitation by its token

GET
/api/v1/auth/invitations/{token}
curl --request GET \
--url https://api.aletheia-ops.com/api/v1/auth/invitations/example
token
required
string

OK

Media typeapplication/json

Public preview of an invitation

object
organization_name
string
inviter_name
string
email
string
state
string
Examplegenerated
{
"organization_name": "example",
"inviter_name": "example",
"email": "example",
"state": "example"
}

The resource does not exist, or belongs to another organization. The two are deliberately indistinguishable.

Media typeapplication/json
object
code
required

Stable, machine-readable identifier. Branch on this.

string
message
required

Human-readable explanation. Safe to display; do not parse.

string
Examples
Examplenot_found
{
"code": "not_found",
"message": "resource not found"
}

An unexpected failure. Diagnostic detail is logged server-side and deliberately not returned. Quote the X-Request-Id response header when reporting one.

Media typeapplication/json
object
code
required

Stable, machine-readable identifier. Branch on this.

string
message
required

Human-readable explanation. Safe to display; do not parse.

string
Examples
Exampleinternal_error
{
"code": "internal_error",
"message": "internal server error"
}