---
title: "overlane view list"
description: "List the project's saved views"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.overlane.app/llms.txt
> Use this file to discover all available pages before exploring further.

# overlane view list

{/* Generated by apps/docs/scripts/generate.mjs (CLI pages from the command registry in packages/cli). Do not edit; run `pnpm --filter @overlane/docs gen`. */}

Lists saved views: a filter plus a group-by and sort over any issue field. With --archived, lists the archived ones that can still be restored.

## Usage

```sh
overlane view list [--archived]
```

## Flags

| Flag | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| `--archived` | boolean | no |  | List the archived views that can still be restored |

## Examples

```sh
overlane view list
overlane view list --archived
```

## Behavior

- Effect: `read` (changes nothing).
- Needs credentials: yes. Uses the network: yes.
- Supports `--dry-run`: no. Accepts `--force`: no.
- Machine-readable description: `overlane schema view list`.

## Result

With `--json` (the default when stdout is not a terminal) the command prints this JSON Schema's shape on stdout.

```json
{
  "type": "object",
  "properties": {
    "views": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "tenantId": {
            "type": "string",
            "minLength": 1,
            "maxLength": 128,
            "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$",
            "description": "tenant identifier"
          },
          "projectId": {
            "type": "string",
            "minLength": 1,
            "maxLength": 128,
            "pattern": "^[A-Za-z0-9][A-Za-z0-9_.:-]*$",
            "description": "project identifier"
          },
          "createdAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
          },
          "updatedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
          },
          "archivedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
          },
          "deletedAt": {
            "type": "string",
            "format": "date-time",
            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
          },
          "viewId": {
            "type": "string",
            "pattern": "^viw_[A-Za-z0-9]{8,32}$",
            "description": "saved view identifier"
          },
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 100
          },
          "definition": {
            "type": "object",
            "properties": {
              "filter": {
                "default": [],
                "maxItems": 20,
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "field": {
                      "type": "string",
                      "enum": [
                        "status",
                        "priority",
                        "assigneeType",
                        "assignee",
                        "labelId",
                        "workProjectId",
                        "cycleId",
                        "estimate",
                        "source",
                        "title",
                        "number",
                        "createdAt",
                        "updatedAt"
                      ]
                    },
                    "op": {
                      "type": "string",
                      "enum": [
                        "eq",
                        "neq",
                        "in",
                        "contains",
                        "gte",
                        "lte",
                        "isnull"
                      ]
                    },
                    "value": {
                      "anyOf": [
                        {
                          "type": "string"
                        },
                        {
                          "type": "number"
                        },
                        {
                          "type": "boolean"
                        },
                        {
                          "type": "array",
                          "items": {
                            "type": [
                              "string",
                              "number"
                            ]
                          }
                        }
                      ]
                    }
                  },
                  "required": [
                    "field",
                    "op"
                  ],
                  "additionalProperties": false
                }
              },
              "groupBy": {
                "default": null,
                "anyOf": [
                  {
                    "type": "string",
                    "enum": [
                      "status",
                      "priority",
                      "assigneeType",
                      "assignee",
                      "labelId",
                      "workProjectId",
                      "cycleId",
                      "estimate",
                      "source",
                      "title",
                      "number",
                      "createdAt",
                      "updatedAt"
                    ]
                  },
                  {
                    "type": "null"
                  }
                ]
              },
              "sortBy": {
                "default": "number",
                "type": "string",
                "enum": [
                  "status",
                  "priority",
                  "assigneeType",
                  "assignee",
                  "labelId",
                  "workProjectId",
                  "cycleId",
                  "estimate",
                  "source",
                  "title",
                  "number",
                  "createdAt",
                  "updatedAt"
                ]
              },
              "sortDirection": {
                "default": "asc",
                "type": "string",
                "enum": [
                  "asc",
                  "desc"
                ]
              }
            },
            "required": [
              "filter",
              "groupBy",
              "sortBy",
              "sortDirection"
            ],
            "additionalProperties": false
          },
          "createdBy": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string",
                "enum": [
                  "human",
                  "agent",
                  "bot",
                  "sync",
                  "import",
                  "system"
                ]
              },
              "id": {
                "type": "string",
                "minLength": 1,
                "maxLength": 200
              }
            },
            "required": [
              "type",
              "id"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "tenantId",
          "projectId",
          "createdAt",
          "updatedAt",
          "viewId",
          "name",
          "definition",
          "createdBy"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "views"
  ],
  "additionalProperties": false
}
```

See [exit codes](/cli/#exit-codes) for the status the process returns.

Source: https://docs.overlane.app/cli/view-list/index.mdx