Playlists on OpenSubsonic

createPlaylist

Mon, 01 Jan 0001 00:00:00 +0000

http://your-server/rest/createPlaylist Since 1.2.0

Creates (or updates) a playlist.

Parameters

Parameter	Req.	Comment
`playlistId`	Yes (if updating)	The playlist ID.
`name`	Yes (if creating)	The human-readable name of the playlist.
`songId`	No	ID of a song in the playlist. Use one `songId` parameter for each song in the playlist.

Example

http://your-server/rest/createPlaylist.view?name=abc&songId=123&u=demo&p=demo&v=1.13.0&c=AwesomeClientName&f=json

Result

Since 1.14.0

A subsonic-response element with a nested playlist element on success.

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "type": "AwesomeServerName",
 "serverVersion": "0.1.3 (tag)",
 "openSubsonic": true,
 "playlist": {
 "id": "800000075",
 "name": "testcreate",
 "owner": "user",
 "public": true,
 "created": "2023-03-16T03:18:41+00:00",
 "changed": "2023-03-16T03:18:41+00:00",
 "songCount": 1,
 "duration": 304,
 "entry": [
 {
 "id": "300000060",
 "parent": "200000002",
 "title": "BrownSmoke",
 "isDir": false,
 "isVideo": false,
 "type": "music",
 "albumId": "200000002",
 "album": "Colorsmoke EP",
 "artistId": "100000002",
 "artist": "Synthetic",
 "coverArt": "300000060",
 "duration": 304,
 "bitRate": 20,
 "bitDepth": 16,
 "samplingRate": 44100,
 "channelCount": 2,
 "userRating": 5,
 "averageRating": 5,
 "track": 4,
 "year": 2007,
 "genre": "Electronic",
 "size": 792375,
 "discNumber": 1,
 "suffix": "wma",
 "contentType": "audio/x-ms-wma",
 "path": "Synthetic/Synthetic_-_Colorsmoke_EP-20k217-2007/04-Synthetic_-_BrownSmokeYSBM20k22khS.wma"
 }
 ]
 }
 }
}

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "playlist": {
 "id": "800000075",
 "name": "testcreate",
 "owner": "user",
 "public": true,
 "created": "2023-03-16T03:18:41+00:00",
 "changed": "2023-03-16T03:18:41+00:00",
 "songCount": 1,
 "duration": 304,
 "entry": [
 {
 "id": "300000060",
 "parent": "200000002",
 "title": "BrownSmoke",
 "isDir": false,
 "isVideo": false,
 "type": "music",
 "albumId": "200000002",
 "album": "Colorsmoke EP",
 "artistId": "100000002",
 "artist": "Synthetic",
 "coverArt": "300000060",
 "duration": 304,
 "bitRate": 20,
 "bitDepth": 16,
 "samplingRate": 44100,
 "channelCount": 2,
 "userRating": 5,
 "averageRating": 5,
 "track": 4,
 "year": 2007,
 "genre": "Electronic",
 "size": 792375,
 "discNumber": 1,
 "suffix": "wma",
 "contentType": "audio/x-ms-wma",
 "path": "Synthetic/Synthetic_-_Colorsmoke_EP-20k217-2007/04-Synthetic_-_BrownSmokeYSBM20k22khS.wma"
 }
 ]
 }
 }
}

Field	Type	Req.	OpenS.	Details
`playlist`	`playlist`	Yes		The created playlist

Before 1.14.0

An empty subsonic-response element on success.

deletePlaylist

Mon, 01 Jan 0001 00:00:00 +0000

http://your-server/rest/deletePlaylist Since 1.2.0

Deletes a saved playlist.

Parameters

Parameter	Req.	OpenS.	Default	Comment
`id`	Yes			ID of the playlist to delete, as obtained by `getPlaylists`.

Example

http://your-server/rest/deletePlaylist.view?id=123&u=demo&p=demo&v=1.13.0&c=AwesomeClientName&f=json

Result

An empty subsonic-response element on success.

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "type": "AwesomeServerName",
 "serverVersion": "0.1.3 (tag)",
 "openSubsonic": true
 }
}

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1"
 }
}

getPlaylist

Mon, 01 Jan 0001 00:00:00 +0000

http://your-server/rest/getPlaylist Since 1.0.0

Returns a listing of files in a saved playlist.

Parameters

Parameter	Req.	OpenS.	Default	Comment
`id`	yes			ID of the playlist to return, as obtained by `getPlaylists`.

Example

http://your-server/rest/getPlaylist.view?id=123&u=demo&p=demo&v=1.13.0&c=AwesomeClientName&f=json

Result

A subsonic-response element with a nested playlist element on success.

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "type": "AwesomeServerName",
 "serverVersion": "0.1.3 (tag)",
 "openSubsonic": true,
 "playlist": {
 "id": "800000075",
 "name": "testcreate",
 "owner": "user",
 "public": true,
 "created": "2023-03-16T03:18:41+00:00",
 "changed": "2023-03-16T03:18:41+00:00",
 "songCount": 1,
 "duration": 304,
 "entry": [
 {
 "id": "300000060",
 "parent": "200000002",
 "title": "BrownSmoke",
 "isDir": false,
 "isVideo": false,
 "type": "music",
 "albumId": "200000002",
 "album": "Colorsmoke EP",
 "artistId": "100000002",
 "artist": "Synthetic",
 "coverArt": "300000060",
 "duration": 304,
 "bitRate": 20,
 "bitDepth": 16,
 "samplingRate": 44100,
 "channelCount": 2,
 "userRating": 5,
 "averageRating": 5,
 "track": 4,
 "year": 2007,
 "genre": "Electronic",
 "size": 792375,
 "discNumber": 1,
 "suffix": "wma",
 "contentType": "audio/x-ms-wma",
 "path": "Synthetic/Synthetic_-_Colorsmoke_EP-20k217-2007/04-Synthetic_-_BrownSmokeYSBM20k22khS.wma"
 }
 ]
 }
 }
}

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "playlist": {
 "id": "800000075",
 "name": "testcreate",
 "owner": "user",
 "public": true,
 "created": "2023-03-16T03:18:41+00:00",
 "changed": "2023-03-16T03:18:41+00:00",
 "songCount": 1,
 "duration": 304,
 "entry": [
 {
 "id": "300000060",
 "parent": "200000002",
 "title": "BrownSmoke",
 "isDir": false,
 "isVideo": false,
 "type": "music",
 "albumId": "200000002",
 "album": "Colorsmoke EP",
 "artistId": "100000002",
 "artist": "Synthetic",
 "coverArt": "300000060",
 "duration": 304,
 "bitRate": 20,
 "bitDepth": 16,
 "samplingRate": 44100,
 "channelCount": 2,
 "userRating": 5,
 "averageRating": 5,
 "track": 4,
 "year": 2007,
 "genre": "Electronic",
 "size": 792375,
 "discNumber": 1,
 "suffix": "wma",
 "contentType": "audio/x-ms-wma",
 "path": "Synthetic/Synthetic_-_Colorsmoke_EP-20k217-2007/04-Synthetic_-_BrownSmokeYSBM20k22khS.wma"
 }
 ]
 }
 }
}

Field	Type	Req.	OpenS.	Details
`playlist`	`playlist`	Yes		The created playlist

getPlaylists

Mon, 01 Jan 0001 00:00:00 +0000

http://your-server/rest/getPlaylists Since 1.0.0

Returns all playlists a user is allowed to play.

Parameters

Parameter	Req.	OpenS.	Default	Comment
`username`	no			(Since 1.8.0) If specified, return playlists for this user rather than for the authenticated user. The authenticated user must have admin role if this parameter is used.

Example

http://your-server/rest/getPlaylists.view?u=demo&p=demo&v=1.13.0&c=AwesomeClientName&f=json

Result

A subsonic-response element with a nested playlists element on success.

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "type": "AwesomeServerName",
 "serverVersion": "0.1.3 (tag)",
 "openSubsonic": true,
 "playlists": {
 "playlist": [
 {
 "id": "800000003",
 "name": "random - admin - private (admin)",
 "owner": "admin",
 "public": false,
 "created": "2021-02-23T04:35:38+00:00",
 "changed": "2021-02-23T04:35:38+00:00",
 "songCount": 43,
 "duration": 17875
 },
 {
 "id": "800000002",
 "name": "random - admin - public (admin)",
 "owner": "admin",
 "public": true,
 "created": "2021-02-23T04:34:56+00:00",
 "changed": "2021-02-23T04:34:56+00:00",
 "songCount": 43,
 "duration": 17786
 }
 ]
 }
 }
}

{
 "subsonic-response": {
 "status": "ok",
 "version": "1.16.1",
 "playlists": {
 "playlist": [
 {
 "id": "800000003",
 "name": "random - admin - private (admin)",
 "owner": "admin",
 "public": false,
 "created": "2021-02-23T04:35:38+00:00",
 "changed": "2021-02-23T04:35:38+00:00",
 "songCount": 43,
 "duration": 17875
 },
 {
 "id": "800000002",
 "name": "random - admin - public (admin)",
 "owner": "admin",
 "public": true,
 "created": "2021-02-23T04:34:56+00:00",
 "changed": "2021-02-23T04:34:56+00:00",
 "songCount": 43,
 "duration": 17786
 }
 ]
 }
 }
}

Field	Type	Req.	OpenS.	Details
`playlists`	`playlists`	Yes		The playlists

updatePlaylist

Mon, 01 Jan 0001 00:00:00 +0000

http://your-server/rest/updatePlaylist Since 1.8.0

Updates a playlist. Only the owner of a playlist is allowed to update it.

Parameters

Parameter	Req.	Comment
`playlistId`	Yes	The playlist ID.
`name`	No	The human-readable name of the playlist.
`comment`	No	The playlist comment.
`public`	No	`true` if the playlist should be visible to all users, `false` otherwise.
`songIdToAdd`	No	Add this song with this ID to the playlist. Multiple parameters allowed.
`songIndexToRemove`	No	Remove the song at this position in the playlist. Multiple parameters allowed.

Example

http://your-server/rest/updatePlaylist.view?playlistId=123&name=test&u=demo&p=demo&v=1.13.0&c=AwesomeClientName&f=json

Result

An empty subsonic-response element on success.