Skip to main content
POST
Create team invitation

Authorizations

Authorization
string
header
required

API key authentication. Use your API key as the bearer token.

Body

application/json
email
string<email>
required

Email address of the person to invite

role
enum<string>
default:member

Role to assign to the invited user

Available options:
member,
admin
Example:

"member"

Response

Invitation created

id
string<uuid>
required
Example:

"123e4567-e89b-12d3-a456-426614174000"

organization_id
string<uuid>
required
email
string<email>
required
role
enum<string>
required
Available options:
member,
admin
status
enum<string>
required
Available options:
pending,
accepted,
expired,
cancelled
invited_by
string<uuid>
required
inviter_name
string | null
required

Full name of the person who sent the invitation

Example:

"John Doe"

inviter_email
string<email>
required

Email of the person who sent the invitation

expires_at
string<date-time>
required
created_at
string<date-time>
required
updated_at
string<date-time>
required