---
title: "Get playlist."
method: GET
path: "/playlists/{uid}"
tags: ["playlists"]
deprecated: true
---

# Get playlist.

`GET /playlists/{uid}`

## Request

- Base URL: `/api` (relative, and the document’s source URL is not known)
- URL: `/api/playlists/{uid}`
- Auth: one of:
  - HTTP basic
  - API key in header `Authorization`

> **Deprecated.**

Please refer to [new API](?api=playlist.grafana.app-v1).

## Path parameters

- `uid` string, required

## Response `200`

(empty)

- PlaylistDTO
  - `interval` string: Interval sets the time between switching views in a playlist.
  - `items` PlaylistItemDTO[]: The ordered list of items that the playlist will iterate over.
    - `title` string: Title is an unused property -- it will be removed in the future
    - `type` string: Type of the item.
    - `value` string: Value depends on type and describes the playlist item. dashboard_by_id: The value is an internal numerical identifier set by Grafana. This is not portable as the numerical identifier is non-deterministic between different instances. Will be replaced by dashboard_by_uid in the future. (deprecated) dashboard_by_tag: The value is a tag which is set on any number of dashboards. All dashboards behind the tag will be added to the playlist. dashboard_by_uid: The value is the dashboard UID
  - `name` string: Name of the playlist.
  - `uid` string: Unique playlist identifier. Generated on creation, either by the creator of the playlist of by the application.

## Other responses

- `401`: UnauthorizedError is returned when the request is not authenticated.
- `403`: ForbiddenError is returned if the user/token has insufficient permissions to access the requested resource.
- `404`: NotFoundError is returned when the requested resource was not found.
- `500`: InternalServerError is a general error indicating something went wrong internally.

---

[API](https://skmtc.dev/grafana/apis/grafana-http-api.md) - [All operations](https://skmtc.dev/grafana/apis/grafana-http-api/llms.txt) - [OpenAPI document](https://skmtc.dev/grafana/apis/grafana-http-api/revisions/df55ba1718ba?raw)