Playlists

Get user's playlists

GET /playlists

Browse the user's playlists. Requires authentication cookie.

Query String Params

Field	Type	Default	Description
limit?	integer	100	Amount of playlists to return
offset?	integer	0	Amount of playlists to skip
fields?	string	N/A	Comma separated string of fields to include. Seems to do nothing currently
mylibrary?	integer	0	Boolean as an integer for whether to include user's My Library playlist
archived?	integer	0	Boolean as an integer for whether to include archived playlists

Response

Field	Type	Description
Playlists	object	Object containing the results
Playlists.Count	integer	The amount of playlists returned
Playlists.Data	array of playlist objects	The playlists returned
Playlists.Fields	object	The query string params used in an object. Values are strings in an array.
Playlists.Limit	integer	The limit used
Playlists.Offset	integer	The offset used
Playlists.Total	integer	The total amount of results that the filtering provides

Get a playlist

GET /playlist/{Playlist.Id}

Gets a playlist's metadata

Response

Field	Type	Description
Playlist	playlist object	The playlist

Get playlist tracks

GET /playlist/{Playlist.Id}/catalog

Browse and search tracks in the playlist.

Query String Params

Field	Type	Default	Description
limit?	integer	100	Amount of tracks to return (max 100)
offset?	integer	0	Amount of tracks to skip
search?	string	N/A	The search terms
sort?	string	playlist	Field to sort by. Prefix with - for descending.
nogold?	boolean	false	Whether to hide tracks in Gold Early Access
streamerMode?	boolean	false	Whether streamer mode is enabled or not
brands?	array of integers	N/A	Brand IDs to filter for
genres?	array of strings	N/A	Genres to filter for
types?	array of strings	N/A	Release types to filter for
tags?	array of strings	N/A	Tags to filter for
creatorFriendly?	boolean	N/A	Whether to filter for creator safe or unsafe tracks
releaseId?	string	N/A	Filter for tracks in a specific release
artistId?	string	N/A	Filter for tracks released by a specific artist

Response

Field	Type	Description
Data	array of track objects	The results of the query
Limit	integer	The limit used
NotFound	array of playlist item objects	The playlist items that weren't found from the catalog
Offset	integer	The offset used
Total	integer	The total amount of results for the search

Create a playlist

POST /playlist

Creates a new playlist. Requires authentication cookie.

JSON Params

A partial playlist object including the fields you want to set instead of defaults (such as Title and Description)

Response

Field	Type	Description
Id	string	The ID of the playlist that was created

Edit a playlist

POST /playlist/{Playlist.Id}

Edits a playlist. Requires authentication cookie.

JSON Parameters

A partial playlist object with the fields you want to replace (such as Title and Description)

Response

The modified playlist object

Modify a playlist item

POST /playlist/{Playlist.Id}/modify-item

Used to reorder tracks. Requires authentication cookie.

Query String Params

Field	Type	Description
type	string	The type of modification

Modification types are:

• add - adds an item
• remove - removes an item
• up - moves an item up by one
• down - moves an item down by one
• to - moves an item to a specific index

JSON Params

Field	Type	Description
MoveTo?	integer	The index to move the item to when using the to type
Record	playlist item object	The item to modify

Modify multiple playlist items

POST /playlist/{Playlist.Id}/modify-items

Used to reorder tracks. Requires authentication cookie.

Query String Params

Field	Type	Description
type	string	The type of modification

Modification types are:

• add - adds items
• remove - removes items

JSON Params

Field	Type	Description
Records	array of playlist item objects	The items to modify

Delete a playlist

POST /playlist/{Playlist.Id}/delete

Deletes a playlist. Requires authentication cookie.

Get playlist tile image

GET /playlist/{Playlist.Id}/tile

Redirects to the original full resolution and quality tile image.
For resizing and different image formats, see CDX

Get playlist background image

GET /playlist/{Playlist.Id}/background

Redirects to the original full resolution and quality background image.
For resizing and different image formats, see CDX