---
title: "List dashboards"
method: GET
path: "/v1/dashboards"
tags: ["dashboards"]
---

# List dashboards

`GET /v1/dashboards`

## Request

- Base URL: `https://api.na-01.cloud.solarwinds.com`
- URL: `https://api.na-01.cloud.solarwinds.com/v1/dashboards`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/solarwinds/apis/solarwinds-observability/docs/v1/dashboards/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `name` string
- `isOwnedByCurrentUser` boolean
- `pageSize` integer
- `skipToken` string

## Response `200`

A paginated list of dashboard summaries.

- object
  - `items` DashboardsDashboardSummary[], required: Dashboard summaries.
    - `id` string, required: Dashboard identifier.
    - `version` integer, nullable, required: Schema version of the dashboard definition. Null implies version 1.
    - `name` string, required: Dashboard display name.
    - `description` string, nullable, required: Dashboard description.
    - `category` DashboardsDashboardCategory, required: A category assigned to a dashboard.
      - `id` string, required: Category identifier.
      - `name` string, required: Category display name.
      - `type` string, required: Category type.
      - `createdAt` string, date-time, required: Timestamp when the category was created.
      - `updatedAt` string, date-time, required: Timestamp when the category was last updated.
    - `systemReference` string, nullable, required: Stable reference key for system dashboards; null for user-created dashboards.
    - `isPrivate` boolean, required: Whether the dashboard is private to the owning user.
    - `ownerId` string, nullable, required: Identifier of the user who owns this dashboard.
    - `createdAt` string, date-time, required: Timestamp when the dashboard was created.
    - `updatedAt` string, date-time, required: Timestamp when the dashboard was last updated.
    - `report` DashboardsDashboardAssociatedReport, required: A report associated with a dashboard.
      - `id` string, required: Report identifier.
      - `title` string, required: Report title.
      - `type` 'Custom' | 'System' | 'DemAvailability', required
    - `isFavorite` boolean, required: Whether the current user has marked this dashboard as a favorite.
  - `pageInfo` CommonPageInfo, required
    - `prevPage` string, required: Token for the previous page, or empty string if on the first page.
    - `nextPage` string, required: Token for the next page, or empty string if on the last page.

## Other responses

- `400`: The server could not understand the request due to invalid syntax.
- `401`: Access is unauthorized.
- `403`: Access is forbidden.
- `500`: Server error

## Changes

- **2026-10-27** `f01485d38ee8`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/solarwinds/apis/solarwinds-observability/changes/v1/dashboards/get.md)

---

[API](https://skmtc.dev/solarwinds/apis/solarwinds-observability.md) - [All operations](https://skmtc.dev/solarwinds/apis/solarwinds-observability/llms.txt) - [OpenAPI document](https://skmtc.dev/solarwinds/apis/solarwinds-observability/revisions/f01485d38ee8?raw)
