---
updatedAt: 2026-10-25T15:46:36.000Z
agentTools:
  projectIndex: https://docs.superwise.ai/llms.txt
---

# Get Dashboards

Returns a paged list of dashboards. Filter by `name`, use `search` for free text, or set `only_archived` to `true` to return archived dashboards only.

## When to use it

Use it to find a dashboard's ID or list the dashboards in your account.

## Required parameters

This call takes no required parameters.

Optional query parameters: `only_archived`, `name`, `search`. Use `page` and `size` to page through the results.

## Response

A successful call returns `200 OK` with a page of `Dashboard` objects in `items`, plus the paging fields `total`, `page`, `size`, and `pages`.

**Related:** [Get a dashboard](https://docs.superwise.ai/reference/get_dashboard), [Search dashboards](https://docs.superwise.ai/reference/search_dashboards), [Create a dashboard](https://docs.superwise.ai/reference/create_dashboard)

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "paths": {
    "/v1/dashboards": {
      "get": {
        "tags": [
          "Dashboards"
        ],
        "summary": "Get Dashboards",
        "operationId": "get_dashboards",
        "parameters": [
          {
            "name": "only_archived",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean",
              "description": "Only return archived dashboards",
              "default": false,
              "title": "Only Archived"
            },
            "description": "Only return archived dashboards"
          },
          {
            "name": "name",
            "in": "query",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Name"
            }
          },
          {
            "name": "search",
            "in": "query",
            "required": false,
            "schema": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "null"
                }
              ],
              "title": "Search"
            }
          },
          {
            "name": "page",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "minimum": 1,
              "description": "Page number",
              "default": 1,
              "title": "Page"
            },
            "description": "Page number"
          },
          {
            "name": "size",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "maximum": 1000,
              "default": 25,
              "title": "Size"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Page_Dashboard_Customized"
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error"
          }
        }
      }
    }
  },
  "info": {
    "title": "Superwise Main Entities",
    "description": "API reference",
    "version": "0.1.0"
  },
  "components": {
    "schemas": {
      "HTTPValidationError": {
        "properties": {
          "detail": {
            "items": {
              "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
          }
        },
        "type": "object",
        "title": "HTTPValidationError"
      },
      "ValidationError": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          },
          "input": {
            "title": "Input"
          },
          "ctx": {
            "type": "object",
            "title": "Context"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      },
      "Dashboard": {
        "properties": {
          "id": {
            "type": "string",
            "format": "uuid",
            "title": "Id"
          },
          "name": {
            "type": "string",
            "maxLength": 100,
            "minLength": 1,
            "title": "name"
          },
          "created_by": {
            "type": "string",
            "title": "Created By"
          },
          "updated_by": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Updated By"
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "title": "Created At"
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "title": "Updated At"
          },
          "positions": {
            "additionalProperties": {
              "$ref": "#/components/schemas/WidgetMeta"
            },
            "propertyNames": {
              "format": "uuid"
            },
            "type": "object",
            "title": "Positions"
          },
          "tags": {
            "items": {
              "type": "string",
              "format": "uuid"
            },
            "type": "array",
            "title": "Tags"
          },
          "archived_at": {
            "anyOf": [
              {
                "type": "string",
                "format": "date-time"
              },
              {
                "type": "null"
              }
            ],
            "title": "Archived At"
          }
        },
        "type": "object",
        "required": [
          "id",
          "name",
          "created_by",
          "created_at",
          "updated_at",
          "positions"
        ],
        "title": "Dashboard"
      },
      "Page_Dashboard_Customized": {
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/Dashboard"
            },
            "type": "array",
            "title": "Items"
          },
          "total": {
            "type": "integer",
            "minimum": 0,
            "title": "Total"
          },
          "page": {
            "type": "integer",
            "minimum": 1,
            "title": "Page"
          },
          "size": {
            "type": "integer",
            "minimum": 1,
            "title": "Size"
          },
          "pages": {
            "type": "integer",
            "minimum": 0,
            "title": "Pages"
          }
        },
        "type": "object",
        "required": [
          "items",
          "total",
          "page",
          "size",
          "pages"
        ],
        "title": "Page[Dashboard]Customized"
      },
      "VisualizationType": {
        "type": "string",
        "enum": [
          "table",
          "line_graph",
          "bar_plot",
          "time_series",
          "histogram",
          "query_value"
        ],
        "title": "VisualizationType"
      },
      "WidgetMeta": {
        "properties": {
          "visualization_type": {
            "$ref": "#/components/schemas/VisualizationType"
          },
          "x_pos": {
            "type": "integer",
            "title": "X Pos"
          },
          "y_pos": {
            "type": "integer",
            "title": "Y Pos"
          },
          "height": {
            "type": "integer",
            "title": "Height",
            "default": 0
          },
          "width": {
            "type": "integer",
            "title": "Width",
            "default": 0
          }
        },
        "type": "object",
        "required": [
          "visualization_type",
          "x_pos",
          "y_pos"
        ],
        "title": "WidgetMeta"
      }
    },
    "securitySchemes": {
      "implicit": {
        "type": "oauth2",
        "flows": {
          "implicit": {
            "authorizationUrl": "https://authentication.superwise.ai/identity/resources/auth/v1/api-token",
            "scopes": {}
          }
        }
      }
    }
  },
  "security": [
    {
      "implicit": []
    }
  ],
  "servers": [
    {
      "url": "api.superwise.ai",
      "description": "Superwise Api Gateway"
    }
  ]
}
```