---
title: "List teamspaces"
method: GET
path: "/api/v1/teamspaces"
tags: ["Teamspaces"]
---

# List teamspaces

`GET /api/v1/teamspaces`

## Request

- Base URL: `https://api.pitch.com`
- URL: `https://api.pitch.com/api/v1/teamspaces`
- Auth: one of:
  - API key in header `X-API-KEY`
  - HTTP bearer

List teamspaces in the workspace. Hidden teamspaces are included only for admins/owners and their members.

## Query parameters

- `limit` integer
- `cursor` string

## Response `200`

- object
  - `data` object[], required
    - `teamspace_id` string, uuid, required
    - `workspace_id` string, uuid, required
    - `name` string, required
    - `description` string, nullable, required
    - `join_policy` 'open' | 'invite-only' | 'mandatory', required
    - `members_can_invite` boolean, required
    - `avatar` object, nullable, required
      - `type` 'icon', required
      - `icon` string, required
      - `color` string, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
  - `pagination` object, required
    - `has_more` boolean, required
    - `next_cursor` string

## Other responses

- `401`
- `403`

---

[API](https://skmtc.dev/pitch/apis/pitch-api.md) - [All operations](https://skmtc.dev/pitch/apis/pitch-api/llms.txt) - [OpenAPI document](https://skmtc.dev/pitch/apis/pitch-api/revisions/68c834acb4bb?raw)
