Teamspaces overview

Teamspaces group members and projects under one team.

The teamspace object

Attributes

• created_at string (date-time)

  When the teamspace was created.

• updated_at string (date-time)

  When the teamspace was last updated.

• created_by_id string (uuid)

  The user who created the teamspace.

• updated_by_id string (uuid) or null

  The user who last updated the teamspace. null until someone updates it.

• description_html string

  Rich-text body as HTML. The Plane editor reads and writes this field.

• id string (uuid)

  Unique identifier.

• lead_id string (uuid)

  id of the teamspace's lead.

• logo_props string

  Logo descriptor managed by the Plane editor. Send back the value you read instead of building it by hand.

• member_ids array of string

  ids of the teamspace's members.

• name string

  Display name.

• project_ids array of string

  ids of the teamspace's projects.

Response200

{
  "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

Method	Path	Description
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
GET	/api/v2/workspaces/{slug}/teamspaces/{pk}/members/	List a teamspace's members
GET	/api/v2/workspaces/{slug}/teamspaces/{pk}/projects/	List a teamspace's projects

The two list routes return the rows behind member_ids and project_ids, paginated, so you don't have to look up each id. They are read-only. Write member_ids and project_ids inline on Create a teamspace and Update a teamspace.

Response shaping

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