Skip to main content
GET
Validate a team invitation

What this endpoint does

Checks whether a one-time team invitation token is valid and returns the invitation details needed by the activation screen.

When to use it

Call it after a recipient opens an invitation link and before showing the account-activation form.

Before you call

Pass the invitation token from the link. This endpoint does not require an API key.

Money and balance effect

This is a read-only request. It does not reserve, debit, credit, or settle money.

States and completion

A token may be valid, expired, already used, or unknown. Only a valid token can be completed.

Safe retries

GET requests are read-only and may be retried with normal exponential backoff. Do not send an Idempotency-Key. Read Team and roles for the complete workflow.

Path Parameters

token
string
required

Response

The minimal context for the setup page.

email
string<email>
required
companyName
string
required
Minimum string length: 1
status
enum<string>
required
Available options:
invited,
active,
suspended