Get a Recommendation Relationship Directly by Name
Fetch a recommendation’s relationship by using its identifier.
URL
GET https://api.music.apple.com/v1/me/recommendations/{id}/{relationship}Path Parameters
| Name | Type | Description |
|---|---|---|
id Required | string | The ID for the recommendation. |
relationship Required | string | The name of the relationship you want to fetch for this recommendation. |
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 |
limit Optional | integer | The number of objects or number of objects in the specified relationship returned. |
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 | RelationshipResponse | The request was successful. |
| 401 | Unauthorized Content-Type: application/json | UnauthorizedResponse | A response indicating an incorrect Authorization header. |
| 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
If successful, the HTTP status code is 200 (OK) and the data array contains a single PersonalRecommendation.Relationships object. If unsuccessful, the HTTP status code indicates the error and the details are in the errors array. For more information, see Handling Requests and Responses.
This endpoint requires a music user token. For more information, see User Authentication for MusicKit.