Skip to main content
POST
Create workspace

Body

application/json

Request payload for creating a new workspace.

Creates a new workspace with the specified configuration. The creator is automatically added as an owner of the workspace.

Request payload for creating a new workspace.

Creates a new workspace with the specified configuration. The creator is automatically added as an owner of the workspace.

displayName
string
required

Display name of the workspace (2-32 characters).

Required string length: 2 - 32
description
string

Optional description of the workspace (max 500 characters).

Maximum string length: 500
settings
object

Workspace settings (approval requirement, data-retention rules). Defaults to requiring approval and keeping everything when omitted.

slug
string

Optional URL slug. Derived from the display name when omitted.

Required string length: 3 - 32
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$

Response

Workspace response.

Workspace response.

createdAt
string<date-time>
required

Timestamp when the workspace was created.

createdBy
object
required

Account that created this workspace.

displayName
string
required

Display name of the workspace.

memberRole
required

Role of the member in the workspace.

Allowed value: "owner"
settings
object
required

Workspace settings (approval requirement, data-retention rules).

slug
string
required

URL-safe workspace identifier.

Required string length: 3 - 32
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
updatedAt
string<date-time>
required

Timestamp when the workspace was last updated.

avatarUrl
string

Serve path of the workspace's avatar (logo), when set.

description
string

Description of the workspace.