Plane DocsSign in

Teamspaces overview ​

Teamspaces group members and projects under one team.

The teamspace object ​

Attributes ​

  • created_at string (date-time)

    When the record was created.

  • created_by_id string (uuid)

    The user who created the record.

  • description_html string

    Rich-text body as HTML. This is the field the Plane editor round-trips.

  • id string (uuid)

    Unique identifier.

  • lead_id string (uuid)

    The related lead.

  • logo_props string

    Editor-owned logo descriptor. Pass back what you read rather than composing it by hand.

  • member_ids array of string

    Ids of the associated members.

  • name string

    Display name.

  • project_ids array of string

    Ids of the associated projects.

Response200
json
{
  "created_at": "2026-01-14T09:22:41.478363Z",
  "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "description_html": "<p>Details go here.</p>",
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "lead_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "logo_props": null,
  "member_ids": [["16c61a3a-512a-48ac-b0be-b6b46fe6f430"]],
  "name": "Example name",
  "project_ids": [["16c61a3a-512a-48ac-b0be-b6b46fe6f430"]]
}

Endpoints ​

MethodPathDescription
GET/api/v2/workspaces/{slug}/teamspaces/List teamspaces
GET/api/v2/workspaces/{slug}/teamspaces/{pk}/Get a teamspace
POST/api/v2/workspaces/{slug}/teamspaces/Create a teamspace
PATCH/api/v2/workspaces/{slug}/teamspaces/{pk}/Update a teamspace
DELETE/api/v2/workspaces/{slug}/teamspaces/{pk}/Delete a teamspace

Response shaping ​

Every teamspace read accepts ?fields= for sparse responses — see Sparse fields. Errors follow the shared problem+json contract.