---
title: "Get Dashboard"
method: GET
path: "/v1/projects/{project_id}/dashboards/{dashboard_id}/"
tags: ["Projects", "Dashboards"]
---

# Get Dashboard

`GET /v1/projects/{project_id}/dashboards/{dashboard_id}/`

## Request

- Base URL: `https://logfire-api.pydantic.dev/api`
- URL: `https://logfire-api.pydantic.dev/api/v1/projects/{project_id}/dashboards/{dashboard_id}/`
- Auth: OAuth 2
  - Authorization code: `api/oauth/authorize`
  - Token URL: `/api/oauth/token` scopes: `project:read_dashboard`
- TypeScript: <https://skmtc.dev/pydantic/apis/pydantic-logfire-api/docs/v1/projects/:project_id/dashboards/:dashboard_id/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `dashboard_id` string, uuid, required
- `project_id` string, uuid, required

## Response `200`

Successful Response

- GetDashboardResponse
  - `dashboard` DashboardDefinitionRead, required
    - `kind` 'Dashboard', required
    - `metadata` DashboardProjectMetadataRead, required
      - `name` string, required
      - `createdAt` string, date-time
      - `updatedAt` string, date-time
      - `version` integer
      - `project` string, required
      - `layoutUpdatedAt` string, date-time
    - `spec` DashboardSpec, required
      - `display` DashboardDisplay, required
        - `name` string, nullable, required
        - `description` string, nullable
      - `datasources` object
      - `variables` DashboardVariable[], required
        - union
          - DashboardTextVariable
            - `kind` 'TextVariable', required
            - `spec` DashboardTextVariableSpec, required
              - …
          - DashboardListVariable
            - `kind` 'ListVariable', required
            - `spec` DashboardListVariableSpec, required
              - …
      - `panels` object, nullable, required
      - `layouts` DashboardLayout[], required
        - `kind` 'Grid', required
        - `spec` DashboardGridSpec, required
          - `display` DashboardGridDisplay
            - `title` string
            - `collapse` DashboardCollapse
              - …
          - `items` DashboardGridItem[], required
            - `x` integer, required
            - `y` integer, required
            - `width` integer, required
            - `height` integer, required
            - `content` PanelRef, required
              - …
      - `duration` string, nullable
      - `refreshInterval` string

## Other responses

- `422`: Validation Error
- `429`: Rate limit exceeded

---

[API](https://skmtc.dev/pydantic/apis/pydantic-logfire-api.md) - [All operations](https://skmtc.dev/pydantic/apis/pydantic-logfire-api/llms.txt) - [OpenAPI document](https://skmtc.dev/pydantic/apis/pydantic-logfire-api/revisions/7996e45256f4?raw)
