add-teamspace.md

title	Create a teamspace
description	Create a teamspace via Plane API. HTTP POST request format, required fields, and example responses.
keywords	plane api, create teamspace, add team, team management, workspace teams, rest api, api integration

Create a teamspace

POST /api/v1/workspaces/{workspace_slug}/teamspaces/

Creates a new teamspace in a workspace.

Path Parameters

The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL https://app.plane.so/my-team/projects/, the workspace slug is my-team.

Body Parameters

Name of the teamspace.

JSON representation of the teamspace description.

HTML-formatted description of the teamspace.

Stripped version of the HTML description.

Binary representation of the description.

Logo properties for the teamspace.

ID of the user who leads the teamspace.

Scopes

teamspaces:write

curl -X POST \
  "https://api.plane.so/api/v1/workspaces/my-workspace/teamspaces/" \
  -H "X-API-Key: $PLANE_API_KEY" \
  # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "example-name",
  "description_json": "example-description_json",
  "description_html": "example-description_html",
  "description_stripped": "example-description_stripped",
  "description_binary": "example-description_binary",
  "logo_props": "example-logo_props",
  "lead": "example-lead"
}'

import requests

response = requests.post(
    "https://api.plane.so/api/v1/workspaces/my-workspace/teamspaces/",
    headers={"X-API-Key": "your-api-key"},
    json={
  'name': 'example-name',
  'description_json': 'example-description_json',
  'description_html': 'example-description_html',
  'description_stripped': 'example-description_stripped',
  'description_binary': 'example-description_binary',
  'logo_props': 'example-logo_props',
  'lead': 'example-lead'
}
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v1/workspaces/my-workspace/teamspaces/",
  {
    method: "POST",
    headers: {
      "X-API-Key": "your-api-key",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
  "name": "example-name",
  "description_json": "example-description_json",
  "description_html": "example-description_html",
  "description_stripped": "example-description_stripped",
  "description_binary": "example-description_binary",
  "logo_props": "example-logo_props",
  "lead": "example-lead"
})
  }
);
const data = await response.json();

{
  "id": "resource-uuid",
  "created_at": "2024-01-01T00:00:00Z"
}