# roadmap_list

List Roadmaps

## Beschreibung

Lists roadmaps the caller can read in the current account.

Visibility: admins and employers see every roadmap in the
account. Other members see only roadmaps in workspaces they're a
member of.

Filters:
- `workspace_id` accepts the workspace's prefix ID (`wsp_…`) or its
  short key (e.g. `ENG`).
- `archived` defaults to false; set true to list archived
  roadmaps instead of active ones.
- `query` is a case-insensitive substring match on `title`.

Returns rows ordered by `updated_at` desc, capped at 250.
Pass any row's `id` (rmap_…) to `roadmap_get` for the full
payload including entries and linked projects.

## Zugriff

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

## Parameter

| Name | Typ | Pflicht | Beschreibung |
| --- | --- | --- | --- |
| `account_id` | string | Ja |  |
| `workspace_id` | string | Nein | Workspace prefix ID (wsp_…) or short key (e.g. ENG). |
| `archived` | boolean | Nein | Default false. Set true to list archived roadmaps instead of active ones. |
| `query` | string | Nein | Case-insensitive substring match on title. |

## Eingabeschema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "account_id": {
      "type": "string"
    },
    "workspace_id": {
      "type": "string",
      "description": "Workspace prefix ID (wsp_…) or short key (e.g. ENG)."
    },
    "archived": {
      "type": "boolean",
      "description": "Default false. Set true to list archived roadmaps instead of active ones."
    },
    "query": {
      "type": "string",
      "description": "Case-insensitive substring match on title."
    }
  },
  "required": [
    "account_id"
  ],
  "type": "object"
}
```

## Ausgabeschema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "roadmaps": {
      "type": "array",
      "description": "Up to 250 rows, sorted by updated_at desc.",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Roadmap prefix ID (rmap_…)."
          },
          "title": {
            "type": "string"
          },
          "status": {
            "type": "string",
            "enum": [
              "planned",
              "in_progress",
              "done"
            ],
            "description": "Editorial state of the roadmap."
          },
          "archived": {
            "type": "boolean"
          },
          "workspace": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "key": {
                "type": "string"
              },
              "name": {
                "type": "string"
              }
            },
            "required": [
              "id",
              "key",
              "name"
            ]
          },
          "entry_count": {
            "type": "integer"
          },
          "updated_at": {
            "type": "string",
            "description": "ISO 8601."
          },
          "created_at": {
            "type": "string",
            "description": "ISO 8601."
          }
        },
        "required": [
          "id",
          "title",
          "status",
          "archived",
          "workspace",
          "entry_count",
          "updated_at",
          "created_at"
        ]
      }
    }
  },
  "required": [
    "roadmaps"
  ],
  "type": "object"
}
```