Retrieve a private playlist

get

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Retrieve one private playlist. Use the same include values as the list endpoint to return the playlist's songs or sound effects in included.

The playlist must belong to the authenticated account or API key. A missing or inaccessible playlist returns 404; test API keys cannot access private playlists.

Path Params

playlist_id

string

required

The playlist's ID

Query Params

include

string

Returns related resources of the private playlist. Must be a comma separated string consisting of one or many: songs, songs.audio_files, songs.artists, sound_effects. For more information on include see the JSON:API spec.

filter[include_alternate_audio_files]

string

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]

string

The number of songs returned when requesting songs via the include param. Defaults to 10 when left blank.

page[number]

string

Specify the page to retrieve when including songs via the include parameter. Defaults to the first page when left blank.

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 — Private playlist retrieved.

400400 — Invalid request parameter.