Shared
ModelsExpand Collapse
AlbumRestrictionObject { published, reason }
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
reason?: "market" | "product" | "explicit"
The reason for the restriction. Albums may be restricted if the content is not available in a given market, to the user's subscription type, or when the user's account is set to not play explicit content. Additional reasons may be added in the future.
ArtistObject { id, external_urls, followers, 8 more }
id?: string
The Spotify ID for the artist.
Known external URLs for this artist.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
spotify?: string
The Spotify URL for the object.
Information about the followers of the artist.
href?: string | null
This will always be set to null, as the Web API does not support it at the moment.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
total?: number
The total number of followers.
genres?: Array<string>
A list of the genres the artist is associated with. If not yet classified, the array is empty.
href?: string
A link to the Web API endpoint providing full details of the artist.
Images of the artist in various sizes, widest first.
height: number | null
The image height in pixels.
url: string
The source URL of the image.
width: number | null
The image width in pixels.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
name?: string
The name of the artist.
popularity?: number
The popularity of the artist. The value will be between 0 and 100, with 100 being the most popular. The artist's popularity is calculated from the popularity of all the artist's tracks.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
type?: "artist"
The object type.
uri?: string
The Spotify URI for the artist.
AudiobookBase { id, authors, available_markets, 17 more }
id: string
The Spotify ID for the audiobook.
The author(s) for the audiobook.
name?: string
The name of the author.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
available_markets: Array<string>
A list of the countries in which the audiobook can be played, identified by their ISO 3166-1 alpha-2 code.
The copyright statements of the audiobook.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
text?: string
The copyright text for this content.
type?: string
The type of copyright: C = the copyright, P = the sound recording (performance) copyright.
description: string
A description of the audiobook. HTML tags are stripped away from this field, use html_description field in case HTML tags are needed.
explicit: boolean
Whether or not the audiobook has explicit content (true = yes it does; false = no it does not OR unknown).
External URLs for this audiobook.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
spotify?: string
The Spotify URL for the object.
href: string
A link to the Web API endpoint providing full details of the audiobook.
html_description: string
A description of the audiobook. This field may contain HTML tags.
The cover art for the audiobook in various sizes, widest first.
height: number | null
The image height in pixels.
url: string
The source URL of the image.
width: number | null
The image width in pixels.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
languages: Array<string>
A list of the languages used in the audiobook, identified by their ISO 639 code.
media_type: string
The media type of the audiobook.
name: string
The name of the audiobook.
The narrator(s) for the audiobook.
name?: string
The name of the Narrator.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
publisher: string
The publisher of the audiobook.
total_chapters: number
The number of chapters in this audiobook.
type: "audiobook"
The object type.
uri: string
The Spotify URI for the audiobook.
edition?: string
The edition of the audiobook.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
AuthorObject { name, published }
name?: string
The name of the author.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
ChapterRestrictionObject { published, reason }
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
reason?: string
The reason for the restriction. Supported values:
market- The content item is not available in the given market.product- The content item is not available for the user's subscription type.explicit- The content item is explicit and the user's account is set to not play explicit content.payment_required- Payment is required to play the content item.
Additional reasons may be added in the future. Note: If you use this field, make sure that your application safely handles unknown values.
CopyrightObject { published, text, type }
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
text?: string
The copyright text for this content.
type?: string
The type of copyright: C = the copyright, P = the sound recording (performance) copyright.
EpisodeObject { id, audio_preview_url, description, 19 more }
id: string
The Spotify ID for the episode.
Deprecatedaudio_preview_url: string | null
A URL to a 30 second preview (MP3 format) of the episode. null if not available.
description: string
A description of the episode. HTML tags are stripped away from this field, use html_description field in case HTML tags are needed.
duration_ms: number
The episode length in milliseconds.
explicit: boolean
Whether or not the episode has explicit content (true = yes it does; false = no it does not OR unknown).
External URLs for this episode.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
spotify?: string
The Spotify URL for the object.
href: string
A link to the Web API endpoint providing full details of the episode.
html_description: string
A description of the episode. This field may contain HTML tags.
The cover art for the episode in various sizes, widest first.
height: number | null
The image height in pixels.
url: string
The source URL of the image.
width: number | null
The image width in pixels.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
is_externally_hosted: boolean
True if the episode is hosted outside of Spotify's CDN.
is_playable: boolean
True if the episode is playable in the given market. Otherwise false.
languages: Array<string>
A list of the languages used in the episode, identified by their ISO 639-1 code.
name: string
The name of the episode.
release_date: string
The date the episode was first released, for example "1981-12-15". Depending on the precision, it might be shown as "1981" or "1981-12".
release_date_precision: "year" | "month" | "day"
The precision with which release_date value is known.
The show on which the episode belongs.
id: string
The Spotify ID for the show.
available_markets: Array<string>
A list of the countries in which the show can be played, identified by their ISO 3166-1 alpha-2 code.
The copyright statements of the show.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
text?: string
The copyright text for this content.
type?: string
The type of copyright: C = the copyright, P = the sound recording (performance) copyright.
description: string
A description of the show. HTML tags are stripped away from this field, use html_description field in case HTML tags are needed.
explicit: boolean
Whether or not the show has explicit content (true = yes it does; false = no it does not OR unknown).
External URLs for this show.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
spotify?: string
The Spotify URL for the object.
href: string
A link to the Web API endpoint providing full details of the show.
html_description: string
A description of the show. This field may contain HTML tags.
The cover art for the show in various sizes, widest first.
height: number | null
The image height in pixels.
url: string
The source URL of the image.
width: number | null
The image width in pixels.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
is_externally_hosted: boolean
True if all of the shows episodes are hosted outside of Spotify's CDN. This field might be null in some cases.
languages: Array<string>
A list of the languages used in the show, identified by their ISO 639 code.
media_type: string
The media type of the show.
name: string
The name of the episode.
publisher: string
The publisher of the show.
total_episodes: number
The total number of episodes in the show.
type: "show"
The object type.
uri: string
The Spotify URI for the show.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
type: "episode"
The object type.
uri: string
The Spotify URI for the episode.
Deprecatedlanguage?: string
The language used in the episode, identified by a ISO 639 code. This field is deprecated and might be removed in the future. Please use the languages field instead.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Included in the response when a content restriction is applied.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
reason?: string
The reason for the restriction. Supported values:
market- The content item is not available in the given market.product- The content item is not available for the user's subscription type.explicit- The content item is explicit and the user's account is set to not play explicit content.
Additional reasons may be added in the future. Note: If you use this field, make sure that your application safely handles unknown values.
The user's most recent position in the episode. Set if the supplied access token is a user token and has the scope 'user-read-playback-position'.
fully_played?: boolean
Whether or not the episode has been fully played by the user.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
resume_position_ms?: number
The user's most recent position in the episode in milliseconds.
EpisodeRestrictionObject { published, reason }
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
reason?: string
The reason for the restriction. Supported values:
market- The content item is not available in the given market.product- The content item is not available for the user's subscription type.explicit- The content item is explicit and the user's account is set to not play explicit content.
Additional reasons may be added in the future. Note: If you use this field, make sure that your application safely handles unknown values.
ExternalIDObject { ean, isrc, published, upc }
ean?: string
isrc?: string
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
upc?: string
ExternalURLObject { published, spotify }
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
spotify?: string
The Spotify URL for the object.
FollowersObject { href, published, total }
href?: string | null
This will always be set to null, as the Web API does not support it at the moment.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
total?: number
The total number of followers.
ImageObject { height, url, width, published }
height: number | null
The image height in pixels.
url: string
The source URL of the image.
width: number | null
The image width in pixels.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
LinkedTrackObject { id, external_urls, href, 3 more }
id?: string
The Spotify ID for the track.
Known external URLs for this track.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
spotify?: string
The Spotify URL for the object.
href?: string
A link to the Web API endpoint providing full details of the track.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
type?: string
The object type: "track".
uri?: string
The Spotify URI for the track.
NarratorObject { name, published }
name?: string
The name of the Narrator.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
PagingPlaylistObject { href, limit, next, 5 more }
href: string
A link to the Web API endpoint returning the full result of the request
limit: number
The maximum number of items in the response (as set in the query or by default).
next: string | null
URL to the next page of items. ( null if none)
offset: number
The offset of the items returned (as set in the query or by default)
previous: string | null
URL to the previous page of items. ( null if none)
total: number
The total number of items available to return.
id?: string
The Spotify ID for the playlist.
collaborative?: boolean
true if the owner allows other users to modify the playlist.
description?: string
The playlist description. Only returned for modified, verified playlists, otherwise null.
Known external URLs for this playlist.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
spotify?: string
The Spotify URL for the object.
href?: string
A link to the Web API endpoint providing full details of the playlist.
Images for the playlist. The array may be empty or contain up to three images. The images are returned by size in descending order. See Working with Playlists. Note: If returned, the source URL for the image (url) is temporary and will expire in less than a day.
height: number | null
The image height in pixels.
url: string
The source URL of the image.
width: number | null
The image width in pixels.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
name?: string
The name of the playlist.
owner?: Owner { display_name }
The user who owns the playlist
display_name?: string | null
The name displayed on the user's profile. null if not available.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
snapshot_id?: string
The version identifier for the current playlist. Can be supplied in other requests to target a specific playlist version
A collection containing a link ( href ) to the Web API endpoint where full details of the playlist's tracks can be retrieved, along with the total number of tracks in the playlist. Note, a track object may be null. This can happen if a track is no longer available.
href?: string
A link to the Web API endpoint where full details of the playlist's tracks can be retrieved.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
total?: number
Number of tracks in the playlist.
type?: string
The object type: "playlist"
uri?: string
The Spotify URI for the playlist.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
PlaylistTrackObject { added_at, added_by, is_local, 2 more }
added_at?: string
The date and time the track or episode was added. Note: some very old playlists may return null in this field.
The Spotify user who added the track or episode. Note: some very old playlists may return null in this field.
id?: string
The Spotify user ID for this user.
Known public external URLs for this user.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
spotify?: string
The Spotify URL for the object.
href?: string
A link to the Web API endpoint for this user.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
type?: "user"
The object type.
uri?: string
The Spotify URI for this user.
is_local?: boolean
Whether this track or episode is a local file or not.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
track?: TrackObject { id, album, artists, 18 more } | EpisodeObject { id, audio_preview_url, description, 19 more }
Information about the track or episode.
TrackObject { id, album, artists, 18 more }
id?: string
The Spotify ID for the track.
album?: Album { id, album_type, artists, 12 more }
The album on which the track appears. The album object includes a link in href to full information about the album.
id: string
The Spotify ID for the album.
album_type: "album" | "single" | "compilation"
The type of the album.
The artists of the album. Each artist object includes a link in href to more detailed information about the artist.
id?: string
The Spotify ID for the artist.
Known external URLs for this artist.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
spotify?: string
The Spotify URL for the object.
href?: string
A link to the Web API endpoint providing full details of the artist.
name?: string
The name of the artist.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
type?: "artist"
The object type.
uri?: string
The Spotify URI for the artist.
available_markets: Array<string>
The markets in which the album is available: ISO 3166-1 alpha-2 country codes. NOTE: an album is considered available in a market when at least 1 of its tracks is available in that market.
Known external URLs for this album.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
spotify?: string
The Spotify URL for the object.
href: string
A link to the Web API endpoint providing full details of the album.
The cover art for the album in various sizes, widest first.
height: number | null
The image height in pixels.
url: string
The source URL of the image.
width: number | null
The image width in pixels.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
name: string
The name of the album. In case of an album takedown, the value may be an empty string.
release_date: string
The date the album was first released.
release_date_precision: "year" | "month" | "day"
The precision with which release_date value is known.
total_tracks: number
The number of tracks in the album.
type: "album"
The object type.
uri: string
The Spotify URI for the album.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Included in the response when a content restriction is applied.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
reason?: "market" | "product" | "explicit"
The reason for the restriction. Albums may be restricted if the content is not available in a given market, to the user's subscription type, or when the user's account is set to not play explicit content. Additional reasons may be added in the future.
The artists who performed the track. Each artist object includes a link in href to more detailed information about the artist.
id?: string
The Spotify ID for the artist.
Known external URLs for this artist.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
spotify?: string
The Spotify URL for the object.
href?: string
A link to the Web API endpoint providing full details of the artist.
name?: string
The name of the artist.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
type?: "artist"
The object type.
uri?: string
The Spotify URI for the artist.
available_markets?: Array<string>
A list of the countries in which the track can be played, identified by their ISO 3166-1 alpha-2 code.
disc_number?: number
The disc number (usually 1 unless the album consists of more than one disc).
duration_ms?: number
The track length in milliseconds.
explicit?: boolean
Whether or not the track has explicit lyrics ( true = yes it does; false = no it does not OR unknown).
Known external IDs for the track.
ean?: string
isrc?: string
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
upc?: string
Known external URLs for this track.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
spotify?: string
The Spotify URL for the object.
href?: string
A link to the Web API endpoint providing full details of the track.
is_local?: boolean
Whether or not the track is from a local file.
is_playable?: boolean
Part of the response when Track Relinking is applied. If true, the track is playable in the given market. Otherwise false.
Part of the response when Track Relinking is applied, and the requested track has been replaced with different track. The track in the linked_from object contains information about the originally requested track.
id?: string
The Spotify ID for the track.
Known external URLs for this track.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
spotify?: string
The Spotify URL for the object.
href?: string
A link to the Web API endpoint providing full details of the track.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
type?: string
The object type: "track".
uri?: string
The Spotify URI for the track.
name?: string
The name of the track.
popularity?: number
The popularity of the track. The value will be between 0 and 100, with 100 being the most popular.
The popularity of a track is a value between 0 and 100, with 100 being the most popular. The popularity is calculated by algorithm and is based, in the most part, on the total number of plays the track has had and how recent those plays are.
Generally speaking, songs that are being played a lot now will have a higher popularity than songs that were played a lot in the past. Duplicate tracks (e.g. the same track from a single and an album) are rated independently. Artist and album popularity is derived mathematically from track popularity. Note: the popularity value may lag actual popularity by a few days: the value is not updated in real time.
Deprecatedpreview_url?: string | null
A link to a 30 second preview (MP3 format) of the track. Can be null
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Included in the response when a content restriction is applied.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
reason?: string
The reason for the restriction. Supported values:
market- The content item is not available in the given market.product- The content item is not available for the user's subscription type.explicit- The content item is explicit and the user's account is set to not play explicit content.
Additional reasons may be added in the future. Note: If you use this field, make sure that your application safely handles unknown values.
track_number?: number
The number of the track. If an album has several discs, the track number is the number on the specified disc.
type?: "track"
The object type: "track".
uri?: string
The Spotify URI for the track.
EpisodeObject { id, audio_preview_url, description, 19 more }
id: string
The Spotify ID for the episode.
Deprecatedaudio_preview_url: string | null
A URL to a 30 second preview (MP3 format) of the episode. null if not available.
description: string
A description of the episode. HTML tags are stripped away from this field, use html_description field in case HTML tags are needed.
duration_ms: number
The episode length in milliseconds.
explicit: boolean
Whether or not the episode has explicit content (true = yes it does; false = no it does not OR unknown).
External URLs for this episode.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
spotify?: string
The Spotify URL for the object.
href: string
A link to the Web API endpoint providing full details of the episode.
html_description: string
A description of the episode. This field may contain HTML tags.
The cover art for the episode in various sizes, widest first.
height: number | null
The image height in pixels.
url: string
The source URL of the image.
width: number | null
The image width in pixels.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
is_externally_hosted: boolean
True if the episode is hosted outside of Spotify's CDN.
is_playable: boolean
True if the episode is playable in the given market. Otherwise false.
languages: Array<string>
A list of the languages used in the episode, identified by their ISO 639-1 code.
name: string
The name of the episode.
release_date: string
The date the episode was first released, for example "1981-12-15". Depending on the precision, it might be shown as "1981" or "1981-12".
release_date_precision: "year" | "month" | "day"
The precision with which release_date value is known.
The show on which the episode belongs.
id: string
The Spotify ID for the show.
available_markets: Array<string>
A list of the countries in which the show can be played, identified by their ISO 3166-1 alpha-2 code.
The copyright statements of the show.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
text?: string
The copyright text for this content.
type?: string
The type of copyright: C = the copyright, P = the sound recording (performance) copyright.
description: string
A description of the show. HTML tags are stripped away from this field, use html_description field in case HTML tags are needed.
explicit: boolean
Whether or not the show has explicit content (true = yes it does; false = no it does not OR unknown).
External URLs for this show.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
spotify?: string
The Spotify URL for the object.
href: string
A link to the Web API endpoint providing full details of the show.
html_description: string
A description of the show. This field may contain HTML tags.
The cover art for the show in various sizes, widest first.
height: number | null
The image height in pixels.
url: string
The source URL of the image.
width: number | null
The image width in pixels.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
is_externally_hosted: boolean
True if all of the shows episodes are hosted outside of Spotify's CDN. This field might be null in some cases.
languages: Array<string>
A list of the languages used in the show, identified by their ISO 639 code.
media_type: string
The media type of the show.
name: string
The name of the episode.
publisher: string
The publisher of the show.
total_episodes: number
The total number of episodes in the show.
type: "show"
The object type.
uri: string
The Spotify URI for the show.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
type: "episode"
The object type.
uri: string
The Spotify URI for the episode.
Deprecatedlanguage?: string
The language used in the episode, identified by a ISO 639 code. This field is deprecated and might be removed in the future. Please use the languages field instead.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Included in the response when a content restriction is applied.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
reason?: string
The reason for the restriction. Supported values:
market- The content item is not available in the given market.product- The content item is not available for the user's subscription type.explicit- The content item is explicit and the user's account is set to not play explicit content.
Additional reasons may be added in the future. Note: If you use this field, make sure that your application safely handles unknown values.
The user's most recent position in the episode. Set if the supplied access token is a user token and has the scope 'user-read-playback-position'.
fully_played?: boolean
Whether or not the episode has been fully played by the user.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
resume_position_ms?: number
The user's most recent position in the episode in milliseconds.
PlaylistTracksRefObject { href, published, total }
href?: string
A link to the Web API endpoint where full details of the playlist's tracks can be retrieved.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
total?: number
Number of tracks in the playlist.
PlaylistUserObject { id, external_urls, href, 3 more }
id?: string
The Spotify user ID for this user.
Known public external URLs for this user.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
spotify?: string
The Spotify URL for the object.
href?: string
A link to the Web API endpoint for this user.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
type?: "user"
The object type.
uri?: string
The Spotify URI for this user.
ResumePointObject { fully_played, published, resume_position_ms }
fully_played?: boolean
Whether or not the episode has been fully played by the user.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
resume_position_ms?: number
The user's most recent position in the episode in milliseconds.
ShowBase { id, available_markets, copyrights, 15 more }
id: string
The Spotify ID for the show.
available_markets: Array<string>
A list of the countries in which the show can be played, identified by their ISO 3166-1 alpha-2 code.
The copyright statements of the show.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
text?: string
The copyright text for this content.
type?: string
The type of copyright: C = the copyright, P = the sound recording (performance) copyright.
description: string
A description of the show. HTML tags are stripped away from this field, use html_description field in case HTML tags are needed.
explicit: boolean
Whether or not the show has explicit content (true = yes it does; false = no it does not OR unknown).
External URLs for this show.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
spotify?: string
The Spotify URL for the object.
href: string
A link to the Web API endpoint providing full details of the show.
html_description: string
A description of the show. This field may contain HTML tags.
The cover art for the show in various sizes, widest first.
height: number | null
The image height in pixels.
url: string
The source URL of the image.
width: number | null
The image width in pixels.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
is_externally_hosted: boolean
True if all of the shows episodes are hosted outside of Spotify's CDN. This field might be null in some cases.
languages: Array<string>
A list of the languages used in the show, identified by their ISO 639 code.
media_type: string
The media type of the show.
name: string
The name of the episode.
publisher: string
The publisher of the show.
total_episodes: number
The total number of episodes in the show.
type: "show"
The object type.
uri: string
The Spotify URI for the show.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
SimplifiedArtistObject { id, external_urls, href, 4 more }
id?: string
The Spotify ID for the artist.
Known external URLs for this artist.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
spotify?: string
The Spotify URL for the object.
href?: string
A link to the Web API endpoint providing full details of the artist.
name?: string
The name of the artist.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
type?: "artist"
The object type.
uri?: string
The Spotify URI for the artist.
SimplifiedEpisodeObject { id, audio_preview_url, description, 18 more }
id: string
The Spotify ID for the episode.
Deprecatedaudio_preview_url: string | null
A URL to a 30 second preview (MP3 format) of the episode. null if not available.
description: string
A description of the episode. HTML tags are stripped away from this field, use html_description field in case HTML tags are needed.
duration_ms: number
The episode length in milliseconds.
explicit: boolean
Whether or not the episode has explicit content (true = yes it does; false = no it does not OR unknown).
External URLs for this episode.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
spotify?: string
The Spotify URL for the object.
href: string
A link to the Web API endpoint providing full details of the episode.
html_description: string
A description of the episode. This field may contain HTML tags.
The cover art for the episode in various sizes, widest first.
height: number | null
The image height in pixels.
url: string
The source URL of the image.
width: number | null
The image width in pixels.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
is_externally_hosted: boolean
True if the episode is hosted outside of Spotify's CDN.
is_playable: boolean
True if the episode is playable in the given market. Otherwise false.
languages: Array<string>
A list of the languages used in the episode, identified by their ISO 639-1 code.
name: string
The name of the episode.
release_date: string
The date the episode was first released, for example "1981-12-15". Depending on the precision, it might be shown as "1981" or "1981-12".
release_date_precision: "year" | "month" | "day"
The precision with which release_date value is known.
type: "episode"
The object type.
uri: string
The Spotify URI for the episode.
Deprecatedlanguage?: string
The language used in the episode, identified by a ISO 639 code. This field is deprecated and might be removed in the future. Please use the languages field instead.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Included in the response when a content restriction is applied.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
reason?: string
The reason for the restriction. Supported values:
market- The content item is not available in the given market.product- The content item is not available for the user's subscription type.explicit- The content item is explicit and the user's account is set to not play explicit content.
Additional reasons may be added in the future. Note: If you use this field, make sure that your application safely handles unknown values.
The user's most recent position in the episode. Set if the supplied access token is a user token and has the scope 'user-read-playback-position'.
fully_played?: boolean
Whether or not the episode has been fully played by the user.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
resume_position_ms?: number
The user's most recent position in the episode in milliseconds.
SimplifiedPlaylistObject { id, collaborative, description, 10 more }
id?: string
The Spotify ID for the playlist.
collaborative?: boolean
true if the owner allows other users to modify the playlist.
description?: string
The playlist description. Only returned for modified, verified playlists, otherwise null.
Known external URLs for this playlist.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
spotify?: string
The Spotify URL for the object.
href?: string
A link to the Web API endpoint providing full details of the playlist.
Images for the playlist. The array may be empty or contain up to three images. The images are returned by size in descending order. See Working with Playlists. Note: If returned, the source URL for the image (url) is temporary and will expire in less than a day.
height: number | null
The image height in pixels.
url: string
The source URL of the image.
width: number | null
The image width in pixels.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
name?: string
The name of the playlist.
owner?: Owner { display_name }
The user who owns the playlist
display_name?: string | null
The name displayed on the user's profile. null if not available.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
snapshot_id?: string
The version identifier for the current playlist. Can be supplied in other requests to target a specific playlist version
A collection containing a link ( href ) to the Web API endpoint where full details of the playlist's tracks can be retrieved, along with the total number of tracks in the playlist. Note, a track object may be null. This can happen if a track is no longer available.
href?: string
A link to the Web API endpoint where full details of the playlist's tracks can be retrieved.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
total?: number
Number of tracks in the playlist.
type?: string
The object type: "playlist"
uri?: string
The Spotify URI for the playlist.
SimplifiedTrackObject { id, artists, available_markets, 15 more }
id?: string
The Spotify ID for the track.
The artists who performed the track. Each artist object includes a link in href to more detailed information about the artist.
id?: string
The Spotify ID for the artist.
Known external URLs for this artist.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
spotify?: string
The Spotify URL for the object.
href?: string
A link to the Web API endpoint providing full details of the artist.
name?: string
The name of the artist.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
type?: "artist"
The object type.
uri?: string
The Spotify URI for the artist.
available_markets?: Array<string>
A list of the countries in which the track can be played, identified by their ISO 3166-1 alpha-2 code.
disc_number?: number
The disc number (usually 1 unless the album consists of more than one disc).
duration_ms?: number
The track length in milliseconds.
explicit?: boolean
Whether or not the track has explicit lyrics ( true = yes it does; false = no it does not OR unknown).
External URLs for this track.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
spotify?: string
The Spotify URL for the object.
href?: string
A link to the Web API endpoint providing full details of the track.
is_local?: boolean
Whether or not the track is from a local file.
is_playable?: boolean
Part of the response when Track Relinking is applied. If true, the track is playable in the given market. Otherwise false.
Part of the response when Track Relinking is applied and is only part of the response if the track linking, in fact, exists. The requested track has been replaced with a different track. The track in the linked_from object contains information about the originally requested track.
id?: string
The Spotify ID for the track.
Known external URLs for this track.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
spotify?: string
The Spotify URL for the object.
href?: string
A link to the Web API endpoint providing full details of the track.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
type?: string
The object type: "track".
uri?: string
The Spotify URI for the track.
name?: string
The name of the track.
Deprecatedpreview_url?: string | null
A URL to a 30 second preview (MP3 format) of the track.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Included in the response when a content restriction is applied.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
reason?: string
The reason for the restriction. Supported values:
market- The content item is not available in the given market.product- The content item is not available for the user's subscription type.explicit- The content item is explicit and the user's account is set to not play explicit content.
Additional reasons may be added in the future. Note: If you use this field, make sure that your application safely handles unknown values.
track_number?: number
The number of the track. If an album has several discs, the track number is the number on the specified disc.
type?: string
The object type: "track".
uri?: string
The Spotify URI for the track.
TrackObject { id, album, artists, 18 more }
id?: string
The Spotify ID for the track.
album?: Album { id, album_type, artists, 12 more }
The album on which the track appears. The album object includes a link in href to full information about the album.
id: string
The Spotify ID for the album.
album_type: "album" | "single" | "compilation"
The type of the album.
The artists of the album. Each artist object includes a link in href to more detailed information about the artist.
id?: string
The Spotify ID for the artist.
Known external URLs for this artist.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
spotify?: string
The Spotify URL for the object.
href?: string
A link to the Web API endpoint providing full details of the artist.
name?: string
The name of the artist.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
type?: "artist"
The object type.
uri?: string
The Spotify URI for the artist.
available_markets: Array<string>
The markets in which the album is available: ISO 3166-1 alpha-2 country codes. NOTE: an album is considered available in a market when at least 1 of its tracks is available in that market.
Known external URLs for this album.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
spotify?: string
The Spotify URL for the object.
href: string
A link to the Web API endpoint providing full details of the album.
The cover art for the album in various sizes, widest first.
height: number | null
The image height in pixels.
url: string
The source URL of the image.
width: number | null
The image width in pixels.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
name: string
The name of the album. In case of an album takedown, the value may be an empty string.
release_date: string
The date the album was first released.
release_date_precision: "year" | "month" | "day"
The precision with which release_date value is known.
total_tracks: number
The number of tracks in the album.
type: "album"
The object type.
uri: string
The Spotify URI for the album.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Included in the response when a content restriction is applied.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
reason?: "market" | "product" | "explicit"
The reason for the restriction. Albums may be restricted if the content is not available in a given market, to the user's subscription type, or when the user's account is set to not play explicit content. Additional reasons may be added in the future.
The artists who performed the track. Each artist object includes a link in href to more detailed information about the artist.
id?: string
The Spotify ID for the artist.
Known external URLs for this artist.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
spotify?: string
The Spotify URL for the object.
href?: string
A link to the Web API endpoint providing full details of the artist.
name?: string
The name of the artist.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
type?: "artist"
The object type.
uri?: string
The Spotify URI for the artist.
available_markets?: Array<string>
A list of the countries in which the track can be played, identified by their ISO 3166-1 alpha-2 code.
disc_number?: number
The disc number (usually 1 unless the album consists of more than one disc).
duration_ms?: number
The track length in milliseconds.
explicit?: boolean
Whether or not the track has explicit lyrics ( true = yes it does; false = no it does not OR unknown).
Known external IDs for the track.
ean?: string
isrc?: string
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
upc?: string
Known external URLs for this track.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
spotify?: string
The Spotify URL for the object.
href?: string
A link to the Web API endpoint providing full details of the track.
is_local?: boolean
Whether or not the track is from a local file.
is_playable?: boolean
Part of the response when Track Relinking is applied. If true, the track is playable in the given market. Otherwise false.
Part of the response when Track Relinking is applied, and the requested track has been replaced with different track. The track in the linked_from object contains information about the originally requested track.
id?: string
The Spotify ID for the track.
Known external URLs for this track.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
spotify?: string
The Spotify URL for the object.
href?: string
A link to the Web API endpoint providing full details of the track.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
type?: string
The object type: "track".
uri?: string
The Spotify URI for the track.
name?: string
The name of the track.
popularity?: number
The popularity of the track. The value will be between 0 and 100, with 100 being the most popular.
The popularity of a track is a value between 0 and 100, with 100 being the most popular. The popularity is calculated by algorithm and is based, in the most part, on the total number of plays the track has had and how recent those plays are.
Generally speaking, songs that are being played a lot now will have a higher popularity than songs that were played a lot in the past. Duplicate tracks (e.g. the same track from a single and an album) are rated independently. Artist and album popularity is derived mathematically from track popularity. Note: the popularity value may lag actual popularity by a few days: the value is not updated in real time.
Deprecatedpreview_url?: string | null
A link to a 30 second preview (MP3 format) of the track. Can be null
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
Included in the response when a content restriction is applied.
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
reason?: string
The reason for the restriction. Supported values:
market- The content item is not available in the given market.product- The content item is not available for the user's subscription type.explicit- The content item is explicit and the user's account is set to not play explicit content.
Additional reasons may be added in the future. Note: If you use this field, make sure that your application safely handles unknown values.
track_number?: number
The number of the track. If an album has several discs, the track number is the number on the specified disc.
type?: "track"
The object type: "track".
uri?: string
The Spotify URI for the track.
TrackRestrictionObject { published, reason }
published?: boolean
The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists
reason?: string
The reason for the restriction. Supported values:
market- The content item is not available in the given market.product- The content item is not available for the user's subscription type.explicit- The content item is explicit and the user's account is set to not play explicit content.
Additional reasons may be added in the future. Note: If you use this field, make sure that your application safely handles unknown values.