Skip to content

Get Invitation

GET
/api/v1/members/invitations/{token}
curl --request GET \
--url https://api.ultimateteam.ai/api/v1/members/invitations/example \
--header 'X-API-Key: <X-API-Key>'

Inspect an invitation token without consuming it.

token
required
Token
string

Successful Response

Media typeapplication/json
InvitationDetails

GET /api/v1/members/invitations/{token} response body.

object
email
required
Email
string format: email
expires_at
required
Expires At
string format: date-time
invited_by
required
Invited By

Inviter email or display name.

string
role
required
Role
string
Allowed values: chairman operator viewer
tenant_name
required
Tenant Name
string
Example
{
"role": "chairman"
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
"detail": [
{
"ctx": {},
"input": "example",
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}