Accounts

Create a workspace and its owner (sets session cookie)

POST
/auth/signup

Create a workspace and its owner (sets session cookie).

Header Parameters

X-Requested-With*string

CSRF guard: must be quartermaster on every mutation.

Request Body

application/json

Create a workspace and its first owner.

Create a workspace and its first owner.

name*string

Display name.

Length1 <= length <= 120
email*string

Email address.

Match^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
Formatemail
Lengthlength <= 254
password*string

Password (never returned by the API).

Length12 <= length <= 200
organization_name*string

Workspace (restaurant) name.

Length2 <= length <= 120
timezone?string

IANA time zone of the workspace.

Lengthlength <= 64
Default"America/Los_Angeles"
sample_data?boolean

Start the workspace with labelled sample suppliers, stock and history.

Defaulttrue

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/auth/signup" \  -H "X-Requested-With: quartermaster" \  -H "Content-Type: application/json" \  -d '{    "name": "Ada Owner",    "email": "ada@example.com",    "password": "correct-horse-battery-staple",    "organization_name": "Ada\'s Kitchen",    "timezone": "America/Los_Angeles",    "sample_data": true  }'
{  "user": {    "id": "string",    "email": "string",    "name": "string",    "role": "OWNER",    "organization": {      "id": "string",      "name": "string",      "timezone": "string",      "currency": "string"    },    "operator": true  }}