Skip to main content
POST
/
workspaces
Create a workspace
curl --request POST \
  --url https://kan.bn/api/v1/workspaces \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "slug": "<string>"
}
'
{
  "publicId": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "description": "<string>",
  "cardPrefix": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
name
string
required
Required string length: 1 - 64
​
description
string
Maximum string length: 280
​
slug
string
Required string length: 3 - 64
Pattern: ^(?![-]+$)[a-zA-Z0-9-]+$

Response

Successful response

​
publicId
string
required
​
name
string
required
​
slug
string
required
​
description
string | null
required
​
plan
enum<string>
required
Available options:
free,
team,
pro,
enterprise
​
cardPrefix
string
required