Overview

Sections

Theme switcher

Get Playlist

Header Parameters

Authorizationstring Required

Access token issued by Tuned Global for authorization using oAuth 2.0.

StoreIdstring Required

API Key provided by Tuned Global for accessing the service.

Path Parameters

idinteger Required

The playlist to open. Access is granted if the listener created it, if it is public, or if the token belongs to an admin

Response

200
Object

The playlist header, identical in shape to the public endpoint's, so one rendering path handles both.

Response Attributes

PlaylistIdinteger

Id of this playlist

Namearray

Name of this playlist

Show child attributes

Descriptionarray

Description / blurb for this playlist

Show child attributes

CreatorIdinteger

Id of the user that made this playlist

CreatorNamestring

Name of the user that made this playlist

CreatorImagestring

URL of an Creator image for this playlist

IsCreatorPublicboolean

Is this playlist publicly visible?

TrackCountinteger

Number of tracks within this playlist

PublicTrackCountinteger

Number of tracks within this playlist for dynamic playlist

IsDynamicboolean

Is this Dyanmic playlist

IsLimitedToContentLangboolean

Is this Dyanmic playlist

DurationSecsinteger

Total duration of this playlist, in seconds

IsPublicboolean

Is this playlist publicly visible?

AllowSuggestionsboolean

Is this playlist editable by users other than the creator?

DateCreatedstring

Timestamp when this playlist was first created

DateUpdatedstring

Timestamp when this playlist was last edited

TrackIdsarray

List of the track ids in this playlist

Show child attributes

CoverImagearray

URL to a cover image for this playList (if any)

Show child attributes

ContentLanguagestring

Language of playlist

IsVideoboolean

Returns true if video otherwise false

StationIdinteger

Returns the Id of the station

IsDraftboolean

An optional boolean indicating whether the playlist is in draft status

ContentTiernumber

Used to control and manage the classification of content within the playlist metadata update process

Enum values:
Tier0Tier1Tier2
IsExplicitboolean
Typestring
404
Object

The playlist does not exist, or the listener may not see it or not accessible.

Was this section helpful?

GET

/

Select
1

Response

Was this section helpful?