Verify Invitation

GET

/api/v1/invitations/verify/{token}

API de Produção

Verify if invitation token is valid (Public endpoint).

Used by frontend to show invitation details before accepting.

Args: token: Invitation token from URL

Returns: Invitation details (email, role, company, expiration)

Parameters

Path Parameters

token

required

Token

string

Responses

200

Successful Response

VerifyInvitationResponse

Response when verifying an invitation token (public endpoint).

object

valid

required

Valid

Whether the invitation is valid

boolean

email

Any of:

string
null

string

role

Any of:

UserRole
null

UserRole

User roles within a tenant.

string

Allowed values: owner admin agent viewer

company_name

Any of:

string
null

string

inviter_name

Any of:

string
null

string

expires_at

Any of:

string
null

string format: date-time

error

Any of:

string
null

string

Example

{
  "company_name": "Healthing Corp",
  "email": "novocolaborador@empresa.com",
  "expires_at": "2025-11-08T12:00:00Z",
  "inviter_name": "João Silva",
  "role": "agent",
  "valid": true
}

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string