app.rocksky.playlist.getPlaylist Documentation (EN)

main query

Retrieve a playlist by its ID

Parameters

filter string Optional

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 Required

The URI of the playlist to retrieve.

Output

Encodingapplication/json

Schemaapp.rocksky.playlist.defs#playlistViewDetailed

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

Parameters

filter 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 * The URI of the playlist to retrieve.

View raw schema

{
  "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"
}