Skip to main content
GET
/
api
/
v1
/
invitations
/
{token}
Get Invitation
curl --request GET \
  --url https://api.example.com/api/v1/invitations/{token}
{
  "email": "[email protected]",
  "account_name": "<string>",
  "invited_by_name": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "is_valid": true
}

Path Parameters

token
string
required

Response

Successful Response

Response schema for public invitation details.

email
string<email>
required

Email address of the invited user

account_name
string
required

Name of the inviting account

invited_by_name
string
required

Name of the person who invited

expires_at
string<date-time>
required

Expiration timestamp

is_valid
boolean
default:true

Whether the invitation is valid