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

# GET /api/v1/dashboards/

`GET /api/v1/dashboards/`

## Request

- Base URL: `https://uptime.com` (the document declares no server; this is the origin it was published from)
- URL: `https://uptime.com/api/v1/dashboards/`
- Auth: none declared
- TypeScript: <https://skmtc.dev/uptime/apis/uptime-com-openapi-schema/docs/api/v1/dashboards/get.ts> (a function with typed inputs; its response is checked against the schema)

List all dashboards

## Query parameters

- `page` integer
- `page_size` integer
- `search` string
- `ordering` 'pk' | '-pk' | 'name' | '-name' | 'ordering' | '-ordering'

## Response `200`

- object
  - `count` integer, required
  - `next` string, uri, nullable
  - `previous` string, uri, nullable
  - `results` Dashboard[], required
    - `pk` integer
    - `url` string
    - `stats_url` string
    - `services_selected` string[]: Include checks from this list
    - `services_tags` string[]: Include checks with one or more of the selected tags
    - `ordering` integer: Sidebar ordering for this dashboard
    - `created_at` string, date-time
    - `name` string: The displayed name for this dashboard
    - `is_pinned` boolean: Whether this dashboard is pinned to the sidebar
    - `metrics_show_section` boolean: Show/hide the Summary Metrics section at the top of this dashboard
    - `metrics_for_all_checks` boolean: Include metrics from all checks, not just the selected checks
    - `services_show_section` boolean: Show/hide the check cards from this dashboard
    - `services_num_to_show` 4 | 8 | 12 | 16 | 20 | 24: Number of check cards to show in the Checks section
    - `match_all_tags` boolean: When true, checks must have all selected tags; when false, checks need only one
    - `services_include_up` boolean: Include/exclude checks which are currently up
    - `services_include_down` boolean: Include/exclude checks which are currently down
    - `services_include_paused` boolean: Include/exclude checks which are currently paused
    - `services_include_maintenance` boolean: Include/exclude checks which are manually marked for maintenance
    - `services_primary_sort` 'cached_ordering' | 'device__address' | '-created_at' | 'is_paused,cached_state_is_up' | '-cached_last_down_alert_at' | '-cached_response_time': The primary value for ordering the checks
    - `services_secondary_sort` 'cached_ordering' | 'device__address' | '-created_at' | 'is_paused,cached_state_is_up' | '-cached_last_down_alert_at' | '-cached_response_time': The secondary value for ordering the checks, if the primary value is the same
    - `services_show_uptime` boolean: Show the 24h uptime percentage on each check card
    - `services_show_response_time` boolean: Show the response time graph or metric on each check card
    - `alerts_show_section` boolean: Show/hide the Latest Alerts section from this dashboard
    - `alerts_for_all_checks` boolean: Show/hide alerts globally across all checks, rather than only for checks selected in the Checks tab
    - `alerts_include_ignored` boolean: Include/exclude alerts marked as "ignored" in the alerts listing
    - `alerts_include_resolved` boolean: Include/exclude alerts that are no longer down in the alerts listing
    - `alerts_num_to_show` 5 | 10 | 15: Number of alerts to show in the Latest Alerts section
    - `charts_show_section` boolean

---

[API](https://skmtc.dev/uptime/apis/uptime-com-openapi-schema.md) - [All operations](https://skmtc.dev/uptime/apis/uptime-com-openapi-schema/llms.txt) - [OpenAPI document](https://skmtc.dev/uptime/apis/uptime-com-openapi-schema/revisions/e1e4a57a60d8?raw)