Register User

Prev Next
Post
/api/v1/users.register
  • Use this endpoint to create an account on the workspace.
  • The number of requests you can make and the interval between each request depends on the workspace's rate limiter settings. You can find the settings from Administration > Settings > Rate Limiter > API Rate Limiter.

Changelog

Version Description
0.50.0 Added
Body parameters
object
username
string Required

The username for the user.

Examplerogersmith
email
string Required

The email for the user.

Example[email protected]
pass
string Required

The password for the user.

Examplepassw0rd
name
string Required

The name of the user. The value can be an empty string if Require Name For Signup is disabled in account registration.

ExampleRoger Smith
secretURL
string

String appended to secret registration URL.

ExampleJjwjg6gouWLXhMGKW
Responses
200

OK

Success Example
{
  "user": {
    "_id": "nSYqWzZ4GsKTX4dyK",
    "type": "user",
    "status": "offline",
    "active": true,
    "name": "Example User",
    "utcOffset": 0,
    "username": "example"
  },
  "success": true
}
Expand All
object
user
object
_id
string
type
string
status
string
active
boolean
name
string
utcOffset
integer
username
string
success
boolean