Skip to main content
POST
/
organizations
/
{organization_id}
/
workspaces
Create workspace for organization
curl --request POST \
  --url https://api.wacht.dev/organizations/{organization_id}/workspaces \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Engineering",
  "description": "Engineering team workspace",
  "image_url": "https://cdn.wacht.dev/workspaces/engineering.png",
  "public_metadata": {},
  "private_metadata": {}
}
'
{
  "id": "4444444444",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-20T15:45:00Z",
  "name": "Engineering",
  "description": "Engineering team workspace",
  "image_url": "https://cdn.wacht.dev/workspaces/engineering.png",
  "member_count": 10,
  "public_metadata": {},
  "private_metadata": {}
}

Authorizations

​
Authorization
string
header
required

API key authentication (Bearer token)

Path Parameters

​
organization_id
string
required

Organization ID (integer as string)

Body

application/json
​
name
string
required

Workspace name

Example:

"Engineering"

​
description
string

Workspace description

Example:

"Engineering team workspace"

​
image_url
string<uri>

Workspace image URL

Example:

"https://cdn.wacht.dev/workspaces/engineering.png"

​
public_metadata
object

Public metadata (custom fields)

Example:
{}
​
private_metadata
object

Private metadata (custom fields)

Example:
{}

Response

Workspace created successfully

​
id
string
required

Workspace ID (integer serialized as string)

Example:

"4444444444"

​
created_at
string<date-time>
required
Example:

"2024-01-15T10:30:00Z"

​
updated_at
string<date-time>
required
Example:

"2024-01-20T15:45:00Z"

​
name
string
required

Workspace name

Example:

"Engineering"

​
description
string
required

Workspace description

Example:

"Engineering team workspace"

​
image_url
string
required

Workspace image URL

Example:

"https://cdn.wacht.dev/workspaces/engineering.png"

​
member_count
integer
required

Number of members in the workspace

Example:

10

​
public_metadata
object
required

Public metadata (custom fields)

Example:
{}
​
private_metadata
object
required

Private metadata (custom fields)

Example:
{}