Get invitation details by token

GET

/api/v1/invitations/{token}

const url = 'http://localhost:3000/api/v1/invitations/example';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:3000/api/v1/invitations/example

Retrieves invitation details using the token from the invitation email. No authentication required.

Parameters

Path Parameters

token

required

string

Invitation token from the email

Header Parameters

x-organization-id

string format: uuid

UUID of the organization (tenant) the request acts in. It selects the tenant and grants nothing: the server checks membership or an open tenant switch. Not needed for global operations. A malformed value returns 400. API keys are fixed to their own organization; another organization returns 403. The x-organization-source header grants nothing.

Responses

200

Invitation details retrieved successfully

application/json

object

token

required

Invitation token

string

email

required

Email address the invitation was sent to

string format: email

organizationName

required

Name of the organization being invited to

string

organizationSlug

required

URL-friendly slug of the organization

string

invitedByName

Name of the user who sent the invitation

string

expiresAt

required

When the invitation expires

string format: date-time

userExists

required

True when a user with this email already exists. The accept form should skip the password field in that case — credentials are preserved and the existing user is just added to the new tenant.

boolean

Example

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "email": "newuser@example.com",
  "organizationName": "Acme Corporation",
  "organizationSlug": "acme-corporation",
  "invitedByName": "Admin User",
  "expiresAt": "2024-06-27T10:30:00Z",
  "userExists": false
}

400

Invalid or expired token

404

Invitation not found