Contents

Get a User's Storefront

Fetch a storefront for a specific user.

URL

GET https://api.music.apple.com/v1/me/storefront

Query Parameters

NameTypeDescription
l Optionalstring

The localization to use, specified by a language tag. The possible values are in the supportedLanguageTags array belonging to the Storefront object specified by storefront. Otherwise, the default is defaultLanguageTag in Storefront.

limit Optionalinteger

The number of objects or number of objects in the specified relationship returned.

include Optional[string]

Additional relationships to include in the fetch.

offset Optionalstring

The offset to use for a paginated request. See Fetching Resources by Page.

extend Optional[string]

A list of attribute extensions to apply to resources in the response.

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
PaginatedResourceCollectionResponse

The request was successful.

401Unauthorized
Content-Type: application/json
UnauthorizedResponse

A response indicating an incorrect Authorization header.

403Forbidden
Content-Type: application/json
ForbiddenResponse

A response indicating invalid or insufficient authentication.

500Internal 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 Storefronts object. If unsuccessful, the HTTP status code indicates the error and the details are in the errors array.

This endpoint requires a music user token. For more information, see User Authentication for MusicKit.

Example

See Also

Related Documentation