Contents

Get a Catalog Station's Relationship Directly by Name

Fetch a station’s relationship using its identifier.

URL

GET https://api.music.apple.com/v1/catalog/{storefront}/stations/{id}/{relationship}

Path Parameters

NameTypeDescription
id Requiredstring

The unique identifier for the station.

relationship Requiredstring

The name of the relationship you want to fetch for the resource.

storefront Requiredstring

An iTunes Store territory, specified by an ISO 3166 alpha-2 country code. The possible values are the id attributes of Storefront objects.

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.

include Optional[string]

Additional relationships to include in the fetch.

extend Optional[string]

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

limit Optionalinteger

The maximum number of related resources from the relationship.

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
RelationshipResponse

The request was successful.

401Unauthorized
Content-Type: application/json
UnauthorizedResponse

A response indicating an incorrect Authorization header.

500Internal Server Error
Content-Type: application/json
ErrorsResponse

A response indicating an error occurred on the server.

Discussion

Example

See Also

Related Documentation

Requesting a Catalog Station