Skip to main content
POST
Error

Authorizations

fastapiusersauth
string
cookie
required

Body

application/json

Request body for creating an invitation.

email
string<email>
required
grants
InvitationGrant · object[]
required
Minimum array length: 1

Response

Successful Response

Response model for an invitation.

id
string<uuid>
required
organization_id
string<uuid>
required
email
string<email>
required
status
enum<string>
required

Invitation lifecycle status.

Available options:
pending,
accepted,
revoked
invited_by
string<uuid> | null
required
expires_at
string<date-time>
required
created_at
string<date-time>
required
accepted_at
string<date-time> | null
required
created_by_platform_admin
boolean
required
grants
InvitationGrant · object[]
required