Get Multiple Catalog Resources Using Resource-Typed ID Parameters
Fetch one or more catalog resources by using their identifiers.
URL
GET https://api.music.apple.com/v1/catalog/{storefront}Path Parameters
| Name | Type | Description |
|---|---|---|
storefront Required | string | An iTunes Store territory, specified by an ISO 3166 alpha-2 country code. The possible values are the |
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. |
ids[stations] Optional | [string] | The unique identifiers for the stations. |
ids[station-genres] Optional | [string] | The unique identifiers for the station genres. |
ids[songs] Optional | [string] | The unique identifiers for the songs. |
ids[record-labels] Optional | [string] | The unique identifiers for the record labels. |
ids[ratings] Optional | [string] | The unique identifiers for the ratings. |
ids[playlists] Optional | [string] | The unique identifiers for the playlists. |
ids[music-videos] Optional | [string] | The unique identifiers for the music videos. |
ids[genres] Optional | [string] | The unique identifiers for the genres. |
ids[curators] Optional | [string] | The unique identifiers for the curators. |
ids[artists] Optional | [string] | The unique identifiers for the artists. |
ids[apple-curators] Optional | [string] | The unique identifiers for the Apple Music curators. |
ids[albums] Optional | [string] | The unique identifiers for the albums. |
ids[activities] Optional | [string] | The unique identifiers for the activities. |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | ResourceCollectionResponse | The request was successful. |
| 401 | Unauthorized Content-Type: application/json | UnauthorizedResponse | A response indicating an incorrect |
| 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 the requested resource 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.