Skip to main content
POST
/
workspaces
Create a workspace
curl --request POST \
  --url https://api.dub.co/workspaces \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "slug": "<string>",
  "domain": "<string>"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "logo": null,
  "usage": 123,
  "usageLimit": 123,
  "linksUsage": 123,
  "linksLimit": 123,
  "domainsLimit": 123,
  "tagsLimit": 123,
  "usersLimit": 123,
  "plan": "free",
  "stripeId": "<string>",
  "billingCycleStart": 123,
  "createdAt": "<string>",
  "users": [
    {
      "role": "owner"
    }
  ],
  "domains": [
    {
      "slug": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Body

application/json
​
name
string
required
Required string length: 1 - 32
​
slug
string
required
Required string length: 3 - 48
​
domain
string

Response

The created workspace

​
id
string
required

The unique ID of the workspace.

​
name
string
required

The name of the workspace.

​
slug
string
required

The slug of the workspace.

The logo of the workspace.

​
usage
number
required

The usage of the workspace.

​
usageLimit
number
required

The usage limit of the workspace.

​
linksUsage
number
required

The links usage of the workspace.

​
linksLimit
number
required

The links limit of the workspace.

​
domainsLimit
number
required

The domains limit of the workspace.

​
tagsLimit
number
required

The tags limit of the workspace.

​
usersLimit
number
required

The users limit of the workspace.

​
plan
enum<string>
required

The plan of the workspace.

Available options:
free,
pro,
business,
business plus,
business extra,
business max,
enterprise
​
stripeId
string | null
required

The Stripe ID of the workspace.

​
billingCycleStart
number
required

The date and time when the billing cycle starts for the workspace.

​
createdAt
string
required

The date and time when the workspace was created.

​
users
object[]
required

The role of the authenticated user in the workspace.

​
domains
object[]
required

The domains of the workspace.