Sign in

v3

latestOpenAPI 3.0.3MIT2026-07-313881,2455.6 MB
Workspace invitations

Creates a new workspace invitations for an email address if the authorized user has admin rights to the related workspace. An email containing a sign up link will be send to the user.

post/api/workspaces/invitations/workspace/{workspace_id}/

Path parameters

workspace_idinteger required

Creates a workspace invitation to the workspace related to the provided value.

Request body

emailstring email required

The email address of the user that the invitation is meant for. Only a user with that email address can accept it.

permissionsstring

The permissions that the user is going to get within the workspace after accepting the invitation.

base_urlstring uri required

The base URL where the user can publicly accept his invitation.The accept token is going to be appended to the base_url (base_url '/token').

Response

idinteger required
workspaceinteger required

The workspace that the user will get access to once the invitation is accepted.

emailstring email required

The email address of the user that the invitation is meant for. Only a user with that email address can accept it.

permissionsstring

The permissions that the user is going to get within the workspace after accepting the invitation.

created_onstring date-time required