List all teamspaces

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

List every teamspace in the workspace, one cursor page at a time.

This route checks teamspace:view on the workspace, which only workspace Owners and Admins hold. A workspace Member gets 403 here even with the teamspaces:read scope. A teamspace member can still read their own teamspace with Retrieve a teamspace.

Path Parameters

workspace_slug:requiredstring

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.

Query Parameters

cursor:optionalstring

Pagination cursor for getting next set of results

per_page:optionalinteger

Number of results per page (default: 20, max: 100)

Scopes

read or teamspaces:read

List all teamspaces

curl -X GET \
  "https://api.plane.so/api/v1/workspaces/my-workspace/teamspaces/?cursor=20:1:0&per_page=20" \
  -H "X-API-Key: $PLANE_API_KEY" \
  # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN"

import requests

response = requests.get(
    "https://api.plane.so/api/v1/workspaces/my-workspace/teamspaces/?cursor=20:1:0&per_page=20",
    headers={"X-API-Key": "your-api-key"}
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v1/workspaces/my-workspace/teamspaces/?cursor=20:1:0&per_page=20",
  {
    method: "GET",
    headers: {
      "X-API-Key": "your-api-key",
    },
  },
);
const data = await response.json();

Response200

{
  "grouped_by": null,
  "sub_grouped_by": null,
  "total_count": 2,
  "next_cursor": "20:1:0",
  "prev_cursor": "20:0:0",
  "next_page_results": false,
  "prev_page_results": false,
  "count": 2,
  "total_pages": 1,
  "total_results": 2,
  "total_groups": null,
  "next_group_offset": null,
  "sub_total_groups": null,
  "sub_next_group_offset": null,
  "extra_stats": null,
  "results": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "created_at": "2023-11-19T11:56:55.176802Z",
      "updated_at": "2023-11-19T11:56:55.176809Z",
      "deleted_at": null,
      "name": "Engineering Team",
      "description_json": {},
      "description_html": "<p>Engineering team workspace</p>",
      "description_stripped": "Engineering team workspace",
      "description_binary": null,
      "logo_props": {
        "in_use": "emoji",
        "emoji": {
          "value": "1f680"
        }
      },
      "created_by": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      "updated_by": null,
      "workspace": "cd4ab5a2-1a5f-4516-a6c6-8da1a9fa5be4",
      "lead": "16c61a3a-512a-48ac-b0be-b6b46fe6f430"
    }
  ]
}