Web Service Endpoint

Get All Library Playlists

Fetch all the library playlists in alphabetical order.

URL

GET https://api.music.apple.com/v1/me/library/playlists

Query Parameters

include
[string]

Additional relationships to include in the fetch.

l
string

The localization to use, specified by a language tag. The possible values are in the supportedLanguageTags array belonging to the Storefront object specified by storefront. Otherwise, the storefront’s defaultLanguageTag is used.

limit
number

The limit on the number of objects, or number of objects in the specified relationship, that are returned. The default value is 25 and the maximum value is 100.

offset
string

The next page or group of objects to fetch.

Response Codes

OK

The request was successful.

Discussion

If successful, the HTTP status code is 200 (OK) and the data array in the ResponseRoot object contains an array of LibraryPlaylist objects. If unsuccessful, the HTTP status code indicates the error and the details are in the errors array. See Handle a Response.

This endpoint requires a music user token. See Getting Keys and Creating Tokens.

Example

https://api.music.apple.com/v1/me/library/playlists
{ "data": [ { "attributes": { "canEdit": true, "description": { "standard": "My description" }, "name": "Some Playlist", "playParams": { "id": "p.MoGJYM3CYXW09B", "isLibrary": true, "kind": "playlist" } }, "href": "/v1/me/library/playlists/p.MoGJYM3CYXW09B", "id": "p.MoGJYM3CYXW09B", "type": "library-playlists" }, { "attributes": { "canEdit": true, "name": "Media API Playlist", "playParams": { "id": "p.8Wx6vK6IQeP0N2", "isLibrary": true, "kind": "playlist" } }, "href": "/v1/me/library/playlists/p.8Wx6vK6IQeP0N2", "id": "p.8Wx6vK6IQeP0N2", "type": "library-playlists" } ]}

See Also

Requesting a Library Playlist

Get a Library Playlist

Fetch a library playlist by using its identifier.

Get a Library Playlist's Relationship Directly by Name

Fetch a library playlist's relationship by using its identifier.

Get Multiple Library Playlists

Fetch one or more library playlists by using their identifiers.