v3

latestOpenAPI 3.0.3MIT2026-07-313881,2455.6 MB
User

Creates a new user based on the provided values. If desired an authentication JWT can be generated right away. After creating an account the initial workspace containing a database is created.

post/api/user/

Request body

namestring required
emailstring email required

The email address is also going to be the username.

passwordstring required
languagestring

An ISO 639 language code (with optional variant) selected by the user. Ex: en-GB.

authenticateboolean

Indicates whether an authentication JWT should be generated and be included in the response.

workspace_invitation_tokenstring

If provided and valid, the user accepts the workspace invitation and will have access to the workspace after signing up.

template_idinteger

The id of the template that must be installed after creating the account. This only works if the workspace_invitation_token param is not provided.

captcha_tokenstring

The captcha response token, required when captcha is enabled.

Response

OR