API Reference

Retrieve a playlist

get
https://api.soundstripe.com/v1/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.

Path Params
string
required

The playlist's ID

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.

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.

int32
Defaults to 10

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

int32
Defaults to 1

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

string

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

Responses

Updated about 1 year ago

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

Updated about 1 year ago