Retrieve a playlist

get

https://api.soundstripe.com/v1/playlists/{playlist_id}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Retrieve one curated playlist by ID. The response identifies the playlist's related media and playlist categories; use include to return the full related resources in included.

Supported include values are songs, songs.artists, songs.audio_files, sound_effects, and playlist_categories. For song playlists, use page[size] and page[number] to select the related-song page returned with the playlist.

curl --get "https://api.soundstripe.com/v1/playlists/7457" \
  -H "Authorization: Token YOUR_API_KEY" \
  -H "Accept: application/vnd.api+json" \
  --data-urlencode "include=songs,songs.audio_files"

Path Params

playlist_id

string

required

The playlist's ID

Query Params

include

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.

filter[include_alternate_audio_files]

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.

page[size]

int32

Defaults to 10

The number of songs or sound effects to be returned for the given playlist.

page[number]

int32

Defaults to 1

Specify the page to retrieve when including songs via the include parameter.

filter[media_type]

string

Returns playlist of that media type. Value can only be songs or sound_effects and defaults to songs if not passed.

Responses

200200 — Curated playlist retrieved.

400400 — Invalid request parameter.