Skip to main content
POST
Create a workspace invite
This endpoint requires a management API key with workspaces:write.
The plaintext token is returned once. Store it securely; subsequent list operations return only a preview.

Authorizations

Authorization
string
header
required

Bearer token authentication

Path Parameters

id
string
required

Workspace UUID or slug.

Body

application/json
role
enum<string>
Available options:
admin,
member
expires_in_days
integer
default:7
Required range: 1 <= x <= 365
max_uses
integer | null
Required range: 1 <= x <= 1000000

Response

Workspace invite created

data
object
required
token
string
required

Plaintext invite token. Returned only when the invite is created.

Last modified on August 30, 2026