Auth

Signup

Create an account and its first workspace (the user is its owner), and log in.

API key access

This route has its own authentication (or none); an API key is not used here.
POST/api/v1/auth/signup
emailstring
Lengthlength <= 320
passwordstring
Length8 <= length <= 256
name?string | null
Lengthlength <= 200
workspace_name?string | null

Defaults to "'s workspace".

Lengthlength <= 200
timezone?string

IANA time zone of the first workspace.

Default"UTC"
country?string | null

ISO 3166-1 alpha-2 code.

invite_token?string | null

RO-292: an invite link's token (roinv_...). The account joins that workspace with the invite's role instead of creating its own (workspace_name, timezone and country are ignored); 400 if the invite is invalid or expired.

Lengthlength <= 100

Response Body

curl -X POST "http://localhost:8000/api/v1/auth/signup" \  -H "Content-Type: application/json" \  -d '{    "email": "string",    "password": "stringst"  }'
{
  "access_token": "string",
  "token_type": "bearer",
  "expires_in": 0,
  "user": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "email": "string",
    "name": "string",
    "created_at": "2019-08-24T14:15:22Z"
  },
  "workspace": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "slug": "string",
    "plan": "free",
    "timezone": "string",
    "country": "string",
    "default_language": "string",
    "suspended_at": "2019-08-24T14:15:22Z",
    "suspended_reason": "string"
  }
}
Empty
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}
Empty