# app.rocksky.playlist.getPlaylist

> Published by [rocksky.app](https://lexicon.garden/identity/did:plc:vegqomyce4ssoqs7zwqvgqty)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:vegqomyce4ssoqs7zwqvgqty/app.rocksky.playlist.getPlaylist)
- [Documentation](https://lexicon.garden/lexicon/did:plc:vegqomyce4ssoqs7zwqvgqty/app.rocksky.playlist.getPlaylist/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:vegqomyce4ssoqs7zwqvgqty/app.rocksky.playlist.getPlaylist/examples)

## Definitions

### `app.rocksky.playlist.getPlaylist`

**Type**: `query`

Retrieve a playlist by its ID

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `filter` | `string` | No | RSQL filter expression applied to the playlist's tracks, e.g. `artist=="Daft Punk";duration=gt=200000`. Supports ==, !=, <, <=, >, >=, =in=, =out=, and `;`/`and`, `,`/`or` combinators, `*` wildcards in string values. Filterable fields: title, artist, album, albumArtist, genre, composer, label, duration, trackNumber, discNumber, mbId, isrc, sha256, uri, albumUri, artistUri, addedAt |
| `uri` | `string` (at-uri) | Yes | The URI of the playlist to retrieve. |

#### Output

**Encoding**: `application/json`

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Retrieve a playlist by its ID",
      "output": {
        "encoding": "application/json",
        "schema": {
          "ref": "app.rocksky.playlist.defs#playlistViewDetailed",
          "type": "ref"
        }
      },
      "parameters": {
        "properties": {
          "filter": {
            "description": "RSQL filter expression applied to the playlist's tracks, e.g. `artist==\"Daft Punk\";duration=gt=200000`. Supports ==, !=, <, <=, >, >=, =in=, =out=, and `;`/`and`, `,`/`or` combinators, `*` wildcards in string values. Filterable fields: title, artist, album, albumArtist, genre, composer, label, duration, trackNumber, discNumber, mbId, isrc, sha256, uri, albumUri, artistUri, addedAt",
            "maxLength": 2048,
            "type": "string"
          },
          "uri": {
            "description": "The URI of the playlist to retrieve.",
            "format": "at-uri",
            "type": "string"
          }
        },
        "required": [
          "uri"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "app.rocksky.playlist.getPlaylist",
  "lexicon": 1
}
```
