List playlists

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

This endpoint retrieves a playlist. When passed with an includes parameter, it can return songs from the playlist along with their primary and alternate audio files. Only the first page of songs and audio files will be returned but remaining pages can be retrieved via the v1/playlists/:id endpoint.

Query Params
string

Returns related resources of the playlist. Must be a comma separated string consisting of one or many: songs, songs.audio_files, songs.artists, playlist_categories. For more information on include see the (JSON:API spec)[https://jsonapi.org/]..

boolean

If true, all audio files for each song will be returned in the audio_files relationship, and in the top-level included key. If false, only primary audio files will be returned in the audio_files relationship, and in the top-level included key. By default, this is false, because response size will be larger when including all audio files for each song.

string

Filter playlists by category. Must be a comma separated string of IDs.

string
Defaults to songs

Filters playlists by media type. Can be either songs or sound_effects

int32
Defaults to 10

The number of Playlists to return from 1-100

int32
Defaults to 1

The desired page number, one-indexed

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json