Skip to main content
POST
/
workspaces
Create Workspace
curl --request POST \
  --url https://{deploymentHost}/workspaces \
  --header 'Content-Type: application/json' \
  --cookie __session= \
  --data '
{
  "name": "<string>",
  "organization_id": "<string>",
  "description": "<string>"
}
'
{
  "status": 201,
  "message": "",
  "data": {
    "workspace": {
      "id": "workspace_123456789",
      "name": "Development Team",
      "description": "Workspace for the development team",
      "organization": {
        "id": "org_456789123",
        "name": "Acme Corporation",
        "slug": "acme-corp"
      },
      "members_count": 1,
      "created_at": "2024-01-15T19:30:00Z",
      "updated_at": "2024-01-15T19:30:00Z"
    }
  },
  "session": {
    "signin_attempts": [],
    "signins": [
      {
        "id": "signin_987654321",
        "user_id": "user_456789123",
        "created_at": "2024-01-01T12:00:00Z"
      }
    ],
    "signup_attempts": [],
    "active_signin": {
      "id": "signin_987654321",
      "user_id": "user_456789123",
      "created_at": "2024-01-01T12:00:00Z"
    }
  },
  "errors": []
}

Authorizations

​
__session
string
cookie
required

Session cookie authentication for production deployments. The session token is automatically set as an HTTP-only, secure cookie.

Body

application/json
​
name
string
required

Workspace name

​
organization_id
string
required

ID of the organization to create workspace in

​
description
string

Workspace description

Response

Workspace created successfully

​
status
integer
required

HTTP status code

​
message
string
required

Response message (empty for success)

​
data
any
required

Response data (can be any type)

​
session
object
required
​
errors
object[]
required

Array of error objects (empty for success)