Web Service Endpoint

Get a Library Playlist's Relationship Directly by Name

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

URL

GET https://api.music.apple.com/v1/me/library/playlists/{id}/{relationship}

Path Parameters

id
string
(Required)

The unique identifier for the library playlist.

relationship
string
(Required)

The name of the relationship you want to fetch for this resource.

Query Parameters

limit
number

The limit on the number of objects, or number of objects in the specified relationship, that are returned.

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 a single LibraryPlaylist.Relationships object. 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.

See Also

Requesting a Library Playlist

Get a Library Playlist

Fetch a library playlist by using its identifier.

Get Multiple Library Playlists

Fetch one or more library playlists by using their identifiers.

Get All Library Playlists

Fetch all the library playlists in alphabetical order.