Skip to main content
POST
Error

Authorizations

fastapiusersauth
string
cookie
required

Path Parameters

org_id
string<uuid>
required

Body

application/json

Create an organization invitation from the platform admin console.

email
string<email>
required
role_slug
enum<string>
default:organization-owner
Available options:
organization-owner,
organization-admin,
organization-member

Response

Successful Response

Create response containing the raw invitation token.

id
string<uuid>
required
organization_id
string<uuid>
required
email
string<email>
required
role_id
string<uuid>
required
role_name
string
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
token
string
required
role_slug
string | null