Get a Personal Playlist Rating
Fetch a user’s rating for a playlist by using the playlist’s identifier.
URL
GET https://api.music.apple.com/v1/me/ratings/playlists/{id}Path Parameters
| Name | Type | Description |
|---|---|---|
id Required | string | The unique identifier for the playlist. |
Query Parameters
| Name | Type | Description |
|---|---|---|
include Optional | [string] | Additional relationships to include in the fetch. |
l Optional | string | The localization to use, specified by a language tag. The possible values are in the |
extend Optional | [string] | A list of attribute extensions to apply to resources in the response. |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | RatingsResponse | The request was successful. |
| 401 | Unauthorized Content-Type: application/json | UnauthorizedResponse | A response indicating an incorrect |
| 403 | Forbidden Content-Type: application/json | ForbiddenResponse | A response indicating invalid or insufficient authentication. |
| 500 | Internal Server Error Content-Type: application/json | ErrorsResponse | A response indicating an error occurred on the server. |
Discussion
This endpoint requires a music user token. For more information, see User Authentication for MusicKit.
A rating indicates whether a user likes (1) or dislikes (-1) the playlist. These are the only two ratings supported.
For a particular playlist, the personal ratings for that playlist’s catalog ID and library ID (if the playlist is in the library) stay synced.
Example
See Also
Related Documentation
Requesting Catalog Ratings
Get a Personal Album RatingGet a Personal Music Video RatingGet a Personal Song RatingGet a Personal Station RatingGet Multiple Personal Album RatingsGet Multiple Personal Music Video RatingsGet Multiple Personal Playlist RatingsGet Multiple Personal Song RatingsGet Multiple Personal Station Ratings