Skip to main content
GET
/
v0
/
auth
/
invitation-preview
Get a public preview of an organization invitation
curl --request GET \
  --url https://api.avidoai.com/v0/auth/invitation-preview
{
  "organizationName": "Acme Inc.",
  "email": "alice@acme.com",
  "status": "pending",
  "expiresAt": "2025-01-01T00:00:00.000Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.avidoai.com/llms.txt

Use this file to discover all available pages before exploring further.

Query Parameters

​
invitationId
string
required

The id of the invitation to preview.

Required string length: 1 - 256
Example:

"550e8400-e29b-41d4-a716-446655440000"

Response

Invitation preview retrieved successfully

Public, unauthenticated invitation preview returned to the invite landing page so it can render the org name and status before the user signs up.

​
organizationName
string
required

The display name of the organization the invitation is for.

Example:

"Acme Inc."

​
email
string<email>
required

The email address the invitation was issued to. The sign-up form locks this field so the user cannot deviate from the invited address.

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
Example:

"alice@acme.com"

​
status
enum<string>
required

Lifecycle status of the invitation. Only pending invitations can be accepted; the UI should surface a terminal-state message for any other value.

Available options:
pending,
accepted,
rejected,
canceled
Example:

"pending"

​
expiresAt
string<date-time>
required

ISO-8601 timestamp at which the invitation expires. UI may surface an expired state if this is in the past.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
Example:

"2025-01-01T00:00:00.000Z"