Web Service Endpoint

Get a Library Album's Relationship Directly by Name

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

URL

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

Path Parameters

id
string
(Required)

A unique identifier for the library album.

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.

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 a single LibraryAlbum.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 User Library Albums

Get a Library Album

Fetch a library album by using its identifier.

Get Multiple Library Albums

Fetch one or more library albums by using their identifiers.

Get All Library Albums

Fetch all the library albums in alphabetical order.