Skip to main content
POST
Invite someone into a workspace

Authorizations

Authorization
string
header
required

Session token as Authorization: Bearer (the CLI and scripts).

Path Parameters

orgSlug
string
required
workspaceSlug
string
required

Body

application/json
email
string<email>
required
Example:

"partner@example.com"

role
enum<string>
required
Available options:
admin,
member,
viewer
Example:

"member"

Response

The pending invitation

id
string
required
email
string
required
Example:

"new@partner.com"

role
string
required
Example:

"member"

status
enum<string>
required
Available options:
pending,
accepted,
declined,
canceled,
expired
organization
object
required
workspace
object | null
required
expiresAt
string
required

ISO timestamp

createdAt
string
required

ISO timestamp

inviterEmail
string
required
inviterName
string
required

The inviter's display name