# workspace_list

List Workspaces

## Beschreibung

Lists visible active workspaces in navigation order. Each
workspace carries the short `key` prefix used to compose issue keys
(`{key}-{number}`, e.g. `ENG-128`) and the membership role of
the calling user. Pass include_archived: true to include archived
workspaces. Admins and employers can pass management: true to list
all workspaces they can administer, including those they haven't joined.
Agent workspace grants still apply. Use workspace_save to create,
edit, archive or restore workspaces.

ENG-1089 — each row also carries the workspace's `cycles` config
block (enabled flag, duration in weeks or custom days,
cooldown, start day, auto-create count, estimates_required).
Useful when an agent needs to know how the workspace is set up
before it talks about sprint windows or velocity.

## Zugriff

Zugriffsprofil: `gated`. Module: `none`.
Die Freigabe im Profil ersetzt keine Account-, Workspace- oder Rollenberechtigung.

## Parameter

| Name | Typ | Pflicht | Beschreibung |
| --- | --- | --- | --- |
| `account_id` | string | Ja | Account prefix ID (acct_…). |
| `include_archived` | boolean | Nein |  |
| `management` | boolean | Nein | Admin/employer only: include workspaces you can administer without being a member. |

## Eingabeschema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "account_id": {
      "type": "string",
      "description": "Account prefix ID (acct_…)."
    },
    "include_archived": {
      "type": "boolean",
      "default": false
    },
    "management": {
      "type": "boolean",
      "default": false,
      "description": "Admin/employer only: include workspaces you can administer without being a member."
    }
  },
  "required": [
    "account_id"
  ],
  "type": "object"
}
```

## Ausgabeschema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "workspaces": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "key": {
            "type": "string"
          },
          "color": {
            "type": "string"
          },
          "description": {
            "type": [
              "string",
              "null"
            ]
          },
          "icon_emoji": {
            "type": [
              "string",
              "null"
            ]
          },
          "archived": {
            "type": "boolean"
          },
          "general": {
            "type": "boolean"
          },
          "key_editable": {
            "type": "boolean"
          },
          "tasks_enabled": {
            "type": "boolean"
          },
          "subtasks_enabled": {
            "type": "boolean"
          },
          "recurring_tasks_enabled": {
            "type": "boolean"
          },
          "projects_enabled": {
            "type": "boolean"
          },
          "roadmaps_enabled": {
            "type": "boolean"
          },
          "estimates_enabled": {
            "type": "boolean"
          },
          "estimate_scale": {
            "type": "string"
          },
          "role": {
            "type": [
              "string",
              "null"
            ],
            "description": "manager / member / null when caller is not on the workspace."
          },
          "cycles": {
            "type": "object",
            "description": "Per-workspace cycles config (ENG-1089). Most workspaces keep defaults; only meaningful once `enabled` is true.",
            "properties": {
              "enabled": {
                "type": "boolean"
              },
              "duration_weeks": {
                "type": [
                  "integer",
                  "null"
                ],
                "description": "1-4 weeks, or null when running on custom_days."
              },
              "custom_days": {
                "type": [
                  "integer",
                  "null"
                ],
                "description": "Cycle length in days when duration_weeks is null."
              },
              "duration_days": {
                "type": [
                  "integer",
                  "null"
                ],
                "description": "Collapsed day count — duration_weeks * 7 or custom_days, whichever is set."
              },
              "cooldown_weeks": {
                "type": "integer",
                "description": "Gap between consecutive cycles, in weeks."
              },
              "start_day": {
                "type": "integer",
                "description": "Date#wday-style: 0 = Sunday, 1 = Monday, …, 6 = Saturday."
              },
              "auto_create_count": {
                "type": "integer",
                "description": "How many upcoming cycles the lifecycle scheduler keeps ahead."
              },
              "estimates_required": {
                "type": "boolean",
                "description": "When true, tasks must carry an estimate before they can be added to a cycle (gates velocity metrics)."
              },
              "carry_over_mode": {
                "type": "string"
              },
              "carry_over_statuses": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              }
            },
            "required": [
              "enabled",
              "cooldown_weeks",
              "start_day",
              "auto_create_count",
              "estimates_required"
            ]
          }
        },
        "required": [
          "id",
          "name",
          "key",
          "color",
          "cycles",
          "archived",
          "general",
          "key_editable"
        ]
      }
    }
  },
  "required": [
    "workspaces"
  ],
  "type": "object"
}
```