Shared
ModelsExpand Collapse
class AlbumRestrictionObject:
Boolean Published
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 Reason
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.
class ArtistObject:
string ID
The Spotify ID for the artist.
ExternalUrlObject ExternalUrls
Known external URLs for this artist.
Boolean Published
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
string Spotify
The Spotify URL for the object.
FollowersObject Followers
Information about the followers of the artist.
string? Href
This will always be set to null, as the Web API does not support it at the moment.
Boolean Published
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
Long Total
The total number of followers.
IReadOnlyList<string> Genres
A list of the genres the artist is associated with. If not yet classified, the array is empty.
string Href
A link to the Web API endpoint providing full details of the artist.
IReadOnlyList<ImageObject> Images
Images of the artist in various sizes, widest first.
required Long? Height
The image height in pixels.
required string Url
The source URL of the image.
required Long? Width
The image width in pixels.
Boolean Published
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
string Name
The name of the artist.
Long Popularity
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.
Boolean Published
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 Type
The object type.
string Uri
The Spotify URI for the artist.
class AudiobookBase:
required string ID
The Spotify ID for the audiobook.
The author(s) for the audiobook.
string Name
The name of the author.
Boolean Published
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
required IReadOnlyList<string> AvailableMarkets
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.
Boolean Published
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
string Text
The copyright text for this content.
string Type
The type of copyright: C = the copyright, P = the sound recording (performance) copyright.
required string Description
A description of the audiobook. HTML tags are stripped away from this field, use html_description field in case HTML tags are needed.
required Boolean Explicit
Whether or not the audiobook has explicit content (true = yes it does; false = no it does not OR unknown).
External URLs for this audiobook.
Boolean Published
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
string Spotify
The Spotify URL for the object.
required string Href
A link to the Web API endpoint providing full details of the audiobook.
required string HtmlDescription
A description of the audiobook. This field may contain HTML tags.
The cover art for the audiobook in various sizes, widest first.
required Long? Height
The image height in pixels.
required string Url
The source URL of the image.
required Long? Width
The image width in pixels.
Boolean Published
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
required IReadOnlyList<string> Languages
A list of the languages used in the audiobook, identified by their ISO 639 code.
required string MediaType
The media type of the audiobook.
required string Name
The name of the audiobook.
The narrator(s) for the audiobook.
string Name
The name of the Narrator.
Boolean Published
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
required string Publisher
The publisher of the audiobook.
required Long TotalChapters
The number of chapters in this audiobook.
JsonElement Type "audiobook"constant
The object type.
required string Uri
The Spotify URI for the audiobook.
string Edition
The edition of the audiobook.
Boolean Published
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
class AuthorObject:
string Name
The name of the author.
Boolean Published
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
class ChapterRestrictionObject:
Boolean Published
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
string Reason
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.
class CopyrightObject:
Boolean Published
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
string Text
The copyright text for this content.
string Type
The type of copyright: C = the copyright, P = the sound recording (performance) copyright.
class EpisodeObject:
required string ID
The Spotify ID for the episode.
Deprecatedrequired string? AudioPreviewUrl
A URL to a 30 second preview (MP3 format) of the episode. null if not available.
required string Description
A description of the episode. HTML tags are stripped away from this field, use html_description field in case HTML tags are needed.
required Long DurationMs
The episode length in milliseconds.
required Boolean Explicit
Whether or not the episode has explicit content (true = yes it does; false = no it does not OR unknown).
External URLs for this episode.
Boolean Published
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
string Spotify
The Spotify URL for the object.
required string Href
A link to the Web API endpoint providing full details of the episode.
required string HtmlDescription
A description of the episode. This field may contain HTML tags.
The cover art for the episode in various sizes, widest first.
required Long? Height
The image height in pixels.
required string Url
The source URL of the image.
required Long? Width
The image width in pixels.
Boolean Published
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
required Boolean IsExternallyHosted
True if the episode is hosted outside of Spotify's CDN.
required Boolean IsPlayable
True if the episode is playable in the given market. Otherwise false.
required IReadOnlyList<string> Languages
A list of the languages used in the episode, identified by their ISO 639-1 code.
required string Name
The name of the episode.
required string ReleaseDate
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".
required ReleaseDatePrecision ReleaseDatePrecision
The precision with which release_date value is known.
The show on which the episode belongs.
required string ID
The Spotify ID for the show.
required IReadOnlyList<string> AvailableMarkets
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.
Boolean Published
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
string Text
The copyright text for this content.
string Type
The type of copyright: C = the copyright, P = the sound recording (performance) copyright.
required string Description
A description of the show. HTML tags are stripped away from this field, use html_description field in case HTML tags are needed.
required Boolean Explicit
Whether or not the show has explicit content (true = yes it does; false = no it does not OR unknown).
External URLs for this show.
Boolean Published
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
string Spotify
The Spotify URL for the object.
required string Href
A link to the Web API endpoint providing full details of the show.
required string HtmlDescription
A description of the show. This field may contain HTML tags.
The cover art for the show in various sizes, widest first.
required Long? Height
The image height in pixels.
required string Url
The source URL of the image.
required Long? Width
The image width in pixels.
Boolean Published
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
required Boolean IsExternallyHosted
True if all of the shows episodes are hosted outside of Spotify's CDN. This field might be null in some cases.
required IReadOnlyList<string> Languages
A list of the languages used in the show, identified by their ISO 639 code.
required string MediaType
The media type of the show.
required string Name
The name of the episode.
required string Publisher
The publisher of the show.
required Long TotalEpisodes
The total number of episodes in the show.
JsonElement Type "show"constant
The object type.
required string Uri
The Spotify URI for the show.
Boolean Published
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
JsonElement Type "episode"constant
The object type.
required string Uri
The Spotify URI for the episode.
Deprecatedstring Language
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.
Boolean Published
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
EpisodeRestrictionObject Restrictions
Included in the response when a content restriction is applied.
Boolean Published
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
string Reason
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.
ResumePointObject ResumePoint
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'.
Boolean FullyPlayed
Whether or not the episode has been fully played by the user.
Boolean Published
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
Long ResumePositionMs
The user's most recent position in the episode in milliseconds.
class EpisodeRestrictionObject:
Boolean Published
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
string Reason
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.
class ExternalIDObject:
string Ean
string Isrc
Boolean Published
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
string Upc
class ExternalUrlObject:
Boolean Published
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
string Spotify
The Spotify URL for the object.
class FollowersObject:
string? Href
This will always be set to null, as the Web API does not support it at the moment.
Boolean Published
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
Long Total
The total number of followers.
class ImageObject:
required Long? Height
The image height in pixels.
required string Url
The source URL of the image.
required Long? Width
The image width in pixels.
Boolean Published
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
class LinkedTrackObject:
string ID
The Spotify ID for the track.
ExternalUrlObject ExternalUrls
Known external URLs for this track.
Boolean Published
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
string Spotify
The Spotify URL for the object.
string Href
A link to the Web API endpoint providing full details of the track.
Boolean Published
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
string Type
The object type: "track".
string Uri
The Spotify URI for the track.
class NarratorObject:
string Name
The name of the Narrator.
Boolean Published
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
class PagingPlaylistObject:
required string Href
A link to the Web API endpoint returning the full result of the request
required Long Limit
The maximum number of items in the response (as set in the query or by default).
required string? Next
URL to the next page of items. ( null if none)
required Long Offset
The offset of the items returned (as set in the query or by default)
required string? Previous
URL to the previous page of items. ( null if none)
required Long Total
The total number of items available to return.
IReadOnlyList<SimplifiedPlaylistObject> Items
string ID
The Spotify ID for the playlist.
Boolean Collaborative
true if the owner allows other users to modify the playlist.
string Description
The playlist description. Only returned for modified, verified playlists, otherwise null.
ExternalUrlObject ExternalUrls
Known external URLs for this playlist.
Boolean Published
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
string Spotify
The Spotify URL for the object.
string Href
A link to the Web API endpoint providing full details of the playlist.
IReadOnlyList<ImageObject> Images
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.
required Long? Height
The image height in pixels.
required string Url
The source URL of the image.
required Long? Width
The image width in pixels.
Boolean Published
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
string Name
The name of the playlist.
Owner Owner
The user who owns the playlist
string? DisplayName
The name displayed on the user's profile. null if not available.
Boolean Published
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
string SnapshotID
The version identifier for the current playlist. Can be supplied in other requests to target a specific playlist version
PlaylistTracksRefObject Tracks
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.
string Href
A link to the Web API endpoint where full details of the playlist's tracks can be retrieved.
Boolean Published
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
Long Total
Number of tracks in the playlist.
string Type
The object type: "playlist"
string Uri
The Spotify URI for the playlist.
Boolean Published
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
class PlaylistTrackObject:
DateTimeOffset AddedAt
The date and time the track or episode was added. Note: some very old playlists may return null in this field.
PlaylistUserObject AddedBy
The Spotify user who added the track or episode. Note: some very old playlists may return null in this field.
string ID
The Spotify user ID for this user.
ExternalUrlObject ExternalUrls
Known public external URLs for this user.
Boolean Published
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
string Spotify
The Spotify URL for the object.
string Href
A link to the Web API endpoint for this user.
Boolean Published
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 Type
The object type.
string Uri
The Spotify URI for this user.
Boolean IsLocal
Whether this track or episode is a local file or not.
Boolean Published
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 Track
Information about the track or episode.
class TrackObject:
string ID
The Spotify ID for the track.
Album Album
The album on which the track appears. The album object includes a link in href to full information about the album.
required string ID
The Spotify ID for the album.
required AlbumType AlbumType
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.
string ID
The Spotify ID for the artist.
ExternalUrlObject ExternalUrls
Known external URLs for this artist.
Boolean Published
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
string Spotify
The Spotify URL for the object.
string Href
A link to the Web API endpoint providing full details of the artist.
string Name
The name of the artist.
Boolean Published
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 Type
The object type.
string Uri
The Spotify URI for the artist.
required IReadOnlyList<string> AvailableMarkets
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.
Boolean Published
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
string Spotify
The Spotify URL for the object.
required string Href
A link to the Web API endpoint providing full details of the album.
The cover art for the album in various sizes, widest first.
required Long? Height
The image height in pixels.
required string Url
The source URL of the image.
required Long? Width
The image width in pixels.
Boolean Published
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
required string Name
The name of the album. In case of an album takedown, the value may be an empty string.
required string ReleaseDate
The date the album was first released.
required ReleaseDatePrecision ReleaseDatePrecision
The precision with which release_date value is known.
required Long TotalTracks
The number of tracks in the album.
JsonElement Type "album"constant
The object type.
required string Uri
The Spotify URI for the album.
Boolean Published
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
AlbumRestrictionObject Restrictions
Included in the response when a content restriction is applied.
Boolean Published
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 Reason
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.
IReadOnlyList<SimplifiedArtistObject> Artists
The artists who performed the track. Each artist object includes a link in href to more detailed information about the artist.
string ID
The Spotify ID for the artist.
ExternalUrlObject ExternalUrls
Known external URLs for this artist.
Boolean Published
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
string Spotify
The Spotify URL for the object.
string Href
A link to the Web API endpoint providing full details of the artist.
string Name
The name of the artist.
Boolean Published
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 Type
The object type.
string Uri
The Spotify URI for the artist.
IReadOnlyList<string> AvailableMarkets
A list of the countries in which the track can be played, identified by their ISO 3166-1 alpha-2 code.
Long DiscNumber
The disc number (usually 1 unless the album consists of more than one disc).
Long DurationMs
The track length in milliseconds.
Boolean Explicit
Whether or not the track has explicit lyrics ( true = yes it does; false = no it does not OR unknown).
ExternalIDObject ExternalIds
Known external IDs for the track.
string Ean
string Isrc
Boolean Published
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
string Upc
ExternalUrlObject ExternalUrls
Known external URLs for this track.
Boolean Published
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
string Spotify
The Spotify URL for the object.
string Href
A link to the Web API endpoint providing full details of the track.
Boolean IsLocal
Whether or not the track is from a local file.
Boolean IsPlayable
Part of the response when Track Relinking is applied. If true, the track is playable in the given market. Otherwise false.
LinkedTrackObject LinkedFrom
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.
string ID
The Spotify ID for the track.
ExternalUrlObject ExternalUrls
Known external URLs for this track.
Boolean Published
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
string Spotify
The Spotify URL for the object.
string Href
A link to the Web API endpoint providing full details of the track.
Boolean Published
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
string Type
The object type: "track".
string Uri
The Spotify URI for the track.
string Name
The name of the track.
Long Popularity
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.
Deprecatedstring? PreviewUrl
A link to a 30 second preview (MP3 format) of the track. Can be null
Boolean Published
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
TrackRestrictionObject Restrictions
Included in the response when a content restriction is applied.
Boolean Published
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
string Reason
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.
Long TrackNumber
The number of the track. If an album has several discs, the track number is the number on the specified disc.
Type Type
The object type: "track".
string Uri
The Spotify URI for the track.
class EpisodeObject:
required string ID
The Spotify ID for the episode.
Deprecatedrequired string? AudioPreviewUrl
A URL to a 30 second preview (MP3 format) of the episode. null if not available.
required string Description
A description of the episode. HTML tags are stripped away from this field, use html_description field in case HTML tags are needed.
required Long DurationMs
The episode length in milliseconds.
required Boolean Explicit
Whether or not the episode has explicit content (true = yes it does; false = no it does not OR unknown).
External URLs for this episode.
Boolean Published
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
string Spotify
The Spotify URL for the object.
required string Href
A link to the Web API endpoint providing full details of the episode.
required string HtmlDescription
A description of the episode. This field may contain HTML tags.
The cover art for the episode in various sizes, widest first.
required Long? Height
The image height in pixels.
required string Url
The source URL of the image.
required Long? Width
The image width in pixels.
Boolean Published
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
required Boolean IsExternallyHosted
True if the episode is hosted outside of Spotify's CDN.
required Boolean IsPlayable
True if the episode is playable in the given market. Otherwise false.
required IReadOnlyList<string> Languages
A list of the languages used in the episode, identified by their ISO 639-1 code.
required string Name
The name of the episode.
required string ReleaseDate
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".
required ReleaseDatePrecision ReleaseDatePrecision
The precision with which release_date value is known.
The show on which the episode belongs.
required string ID
The Spotify ID for the show.
required IReadOnlyList<string> AvailableMarkets
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.
Boolean Published
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
string Text
The copyright text for this content.
string Type
The type of copyright: C = the copyright, P = the sound recording (performance) copyright.
required string Description
A description of the show. HTML tags are stripped away from this field, use html_description field in case HTML tags are needed.
required Boolean Explicit
Whether or not the show has explicit content (true = yes it does; false = no it does not OR unknown).
External URLs for this show.
Boolean Published
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
string Spotify
The Spotify URL for the object.
required string Href
A link to the Web API endpoint providing full details of the show.
required string HtmlDescription
A description of the show. This field may contain HTML tags.
The cover art for the show in various sizes, widest first.
required Long? Height
The image height in pixels.
required string Url
The source URL of the image.
required Long? Width
The image width in pixels.
Boolean Published
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
required Boolean IsExternallyHosted
True if all of the shows episodes are hosted outside of Spotify's CDN. This field might be null in some cases.
required IReadOnlyList<string> Languages
A list of the languages used in the show, identified by their ISO 639 code.
required string MediaType
The media type of the show.
required string Name
The name of the episode.
required string Publisher
The publisher of the show.
required Long TotalEpisodes
The total number of episodes in the show.
JsonElement Type "show"constant
The object type.
required string Uri
The Spotify URI for the show.
Boolean Published
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
JsonElement Type "episode"constant
The object type.
required string Uri
The Spotify URI for the episode.
Deprecatedstring Language
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.
Boolean Published
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
EpisodeRestrictionObject Restrictions
Included in the response when a content restriction is applied.
Boolean Published
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
string Reason
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.
ResumePointObject ResumePoint
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'.
Boolean FullyPlayed
Whether or not the episode has been fully played by the user.
Boolean Published
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
Long ResumePositionMs
The user's most recent position in the episode in milliseconds.
class PlaylistTracksRefObject:
string Href
A link to the Web API endpoint where full details of the playlist's tracks can be retrieved.
Boolean Published
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
Long Total
Number of tracks in the playlist.
class PlaylistUserObject:
string ID
The Spotify user ID for this user.
ExternalUrlObject ExternalUrls
Known public external URLs for this user.
Boolean Published
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
string Spotify
The Spotify URL for the object.
string Href
A link to the Web API endpoint for this user.
Boolean Published
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 Type
The object type.
string Uri
The Spotify URI for this user.
class ResumePointObject:
Boolean FullyPlayed
Whether or not the episode has been fully played by the user.
Boolean Published
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
Long ResumePositionMs
The user's most recent position in the episode in milliseconds.
class ShowBase:
required string ID
The Spotify ID for the show.
required IReadOnlyList<string> AvailableMarkets
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.
Boolean Published
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
string Text
The copyright text for this content.
string Type
The type of copyright: C = the copyright, P = the sound recording (performance) copyright.
required string Description
A description of the show. HTML tags are stripped away from this field, use html_description field in case HTML tags are needed.
required Boolean Explicit
Whether or not the show has explicit content (true = yes it does; false = no it does not OR unknown).
External URLs for this show.
Boolean Published
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
string Spotify
The Spotify URL for the object.
required string Href
A link to the Web API endpoint providing full details of the show.
required string HtmlDescription
A description of the show. This field may contain HTML tags.
The cover art for the show in various sizes, widest first.
required Long? Height
The image height in pixels.
required string Url
The source URL of the image.
required Long? Width
The image width in pixels.
Boolean Published
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
required Boolean IsExternallyHosted
True if all of the shows episodes are hosted outside of Spotify's CDN. This field might be null in some cases.
required IReadOnlyList<string> Languages
A list of the languages used in the show, identified by their ISO 639 code.
required string MediaType
The media type of the show.
required string Name
The name of the episode.
required string Publisher
The publisher of the show.
required Long TotalEpisodes
The total number of episodes in the show.
JsonElement Type "show"constant
The object type.
required string Uri
The Spotify URI for the show.
Boolean Published
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
class SimplifiedArtistObject:
string ID
The Spotify ID for the artist.
ExternalUrlObject ExternalUrls
Known external URLs for this artist.
Boolean Published
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
string Spotify
The Spotify URL for the object.
string Href
A link to the Web API endpoint providing full details of the artist.
string Name
The name of the artist.
Boolean Published
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 Type
The object type.
string Uri
The Spotify URI for the artist.
class SimplifiedEpisodeObject:
required string ID
The Spotify ID for the episode.
Deprecatedrequired string? AudioPreviewUrl
A URL to a 30 second preview (MP3 format) of the episode. null if not available.
required string Description
A description of the episode. HTML tags are stripped away from this field, use html_description field in case HTML tags are needed.
required Long DurationMs
The episode length in milliseconds.
required Boolean Explicit
Whether or not the episode has explicit content (true = yes it does; false = no it does not OR unknown).
External URLs for this episode.
Boolean Published
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
string Spotify
The Spotify URL for the object.
required string Href
A link to the Web API endpoint providing full details of the episode.
required string HtmlDescription
A description of the episode. This field may contain HTML tags.
The cover art for the episode in various sizes, widest first.
required Long? Height
The image height in pixels.
required string Url
The source URL of the image.
required Long? Width
The image width in pixels.
Boolean Published
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
required Boolean IsExternallyHosted
True if the episode is hosted outside of Spotify's CDN.
required Boolean IsPlayable
True if the episode is playable in the given market. Otherwise false.
required IReadOnlyList<string> Languages
A list of the languages used in the episode, identified by their ISO 639-1 code.
required string Name
The name of the episode.
required string ReleaseDate
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".
required ReleaseDatePrecision ReleaseDatePrecision
The precision with which release_date value is known.
JsonElement Type "episode"constant
The object type.
required string Uri
The Spotify URI for the episode.
Deprecatedstring Language
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.
Boolean Published
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
EpisodeRestrictionObject Restrictions
Included in the response when a content restriction is applied.
Boolean Published
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
string Reason
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.
ResumePointObject ResumePoint
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'.
Boolean FullyPlayed
Whether or not the episode has been fully played by the user.
Boolean Published
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
Long ResumePositionMs
The user's most recent position in the episode in milliseconds.
class SimplifiedPlaylistObject:
string ID
The Spotify ID for the playlist.
Boolean Collaborative
true if the owner allows other users to modify the playlist.
string Description
The playlist description. Only returned for modified, verified playlists, otherwise null.
ExternalUrlObject ExternalUrls
Known external URLs for this playlist.
Boolean Published
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
string Spotify
The Spotify URL for the object.
string Href
A link to the Web API endpoint providing full details of the playlist.
IReadOnlyList<ImageObject> Images
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.
required Long? Height
The image height in pixels.
required string Url
The source URL of the image.
required Long? Width
The image width in pixels.
Boolean Published
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
string Name
The name of the playlist.
Owner Owner
The user who owns the playlist
string? DisplayName
The name displayed on the user's profile. null if not available.
Boolean Published
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
string SnapshotID
The version identifier for the current playlist. Can be supplied in other requests to target a specific playlist version
PlaylistTracksRefObject Tracks
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.
string Href
A link to the Web API endpoint where full details of the playlist's tracks can be retrieved.
Boolean Published
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
Long Total
Number of tracks in the playlist.
string Type
The object type: "playlist"
string Uri
The Spotify URI for the playlist.
class SimplifiedTrackObject:
string ID
The Spotify ID for the track.
IReadOnlyList<SimplifiedArtistObject> Artists
The artists who performed the track. Each artist object includes a link in href to more detailed information about the artist.
string ID
The Spotify ID for the artist.
ExternalUrlObject ExternalUrls
Known external URLs for this artist.
Boolean Published
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
string Spotify
The Spotify URL for the object.
string Href
A link to the Web API endpoint providing full details of the artist.
string Name
The name of the artist.
Boolean Published
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 Type
The object type.
string Uri
The Spotify URI for the artist.
IReadOnlyList<string> AvailableMarkets
A list of the countries in which the track can be played, identified by their ISO 3166-1 alpha-2 code.
Long DiscNumber
The disc number (usually 1 unless the album consists of more than one disc).
Long DurationMs
The track length in milliseconds.
Boolean Explicit
Whether or not the track has explicit lyrics ( true = yes it does; false = no it does not OR unknown).
ExternalUrlObject ExternalUrls
External URLs for this track.
Boolean Published
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
string Spotify
The Spotify URL for the object.
string Href
A link to the Web API endpoint providing full details of the track.
Boolean IsLocal
Whether or not the track is from a local file.
Boolean IsPlayable
Part of the response when Track Relinking is applied. If true, the track is playable in the given market. Otherwise false.
LinkedTrackObject LinkedFrom
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.
string ID
The Spotify ID for the track.
ExternalUrlObject ExternalUrls
Known external URLs for this track.
Boolean Published
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
string Spotify
The Spotify URL for the object.
string Href
A link to the Web API endpoint providing full details of the track.
Boolean Published
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
string Type
The object type: "track".
string Uri
The Spotify URI for the track.
string Name
The name of the track.
Deprecatedstring? PreviewUrl
A URL to a 30 second preview (MP3 format) of the track.
Boolean Published
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
TrackRestrictionObject Restrictions
Included in the response when a content restriction is applied.
Boolean Published
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
string Reason
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.
Long TrackNumber
The number of the track. If an album has several discs, the track number is the number on the specified disc.
string Type
The object type: "track".
string Uri
The Spotify URI for the track.
class TrackObject:
string ID
The Spotify ID for the track.
Album Album
The album on which the track appears. The album object includes a link in href to full information about the album.
required string ID
The Spotify ID for the album.
required AlbumType AlbumType
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.
string ID
The Spotify ID for the artist.
ExternalUrlObject ExternalUrls
Known external URLs for this artist.
Boolean Published
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
string Spotify
The Spotify URL for the object.
string Href
A link to the Web API endpoint providing full details of the artist.
string Name
The name of the artist.
Boolean Published
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 Type
The object type.
string Uri
The Spotify URI for the artist.
required IReadOnlyList<string> AvailableMarkets
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.
Boolean Published
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
string Spotify
The Spotify URL for the object.
required string Href
A link to the Web API endpoint providing full details of the album.
The cover art for the album in various sizes, widest first.
required Long? Height
The image height in pixels.
required string Url
The source URL of the image.
required Long? Width
The image width in pixels.
Boolean Published
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
required string Name
The name of the album. In case of an album takedown, the value may be an empty string.
required string ReleaseDate
The date the album was first released.
required ReleaseDatePrecision ReleaseDatePrecision
The precision with which release_date value is known.
required Long TotalTracks
The number of tracks in the album.
JsonElement Type "album"constant
The object type.
required string Uri
The Spotify URI for the album.
Boolean Published
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
AlbumRestrictionObject Restrictions
Included in the response when a content restriction is applied.
Boolean Published
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 Reason
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.
IReadOnlyList<SimplifiedArtistObject> Artists
The artists who performed the track. Each artist object includes a link in href to more detailed information about the artist.
string ID
The Spotify ID for the artist.
ExternalUrlObject ExternalUrls
Known external URLs for this artist.
Boolean Published
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
string Spotify
The Spotify URL for the object.
string Href
A link to the Web API endpoint providing full details of the artist.
string Name
The name of the artist.
Boolean Published
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 Type
The object type.
string Uri
The Spotify URI for the artist.
IReadOnlyList<string> AvailableMarkets
A list of the countries in which the track can be played, identified by their ISO 3166-1 alpha-2 code.
Long DiscNumber
The disc number (usually 1 unless the album consists of more than one disc).
Long DurationMs
The track length in milliseconds.
Boolean Explicit
Whether or not the track has explicit lyrics ( true = yes it does; false = no it does not OR unknown).
ExternalIDObject ExternalIds
Known external IDs for the track.
string Ean
string Isrc
Boolean Published
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
string Upc
ExternalUrlObject ExternalUrls
Known external URLs for this track.
Boolean Published
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
string Spotify
The Spotify URL for the object.
string Href
A link to the Web API endpoint providing full details of the track.
Boolean IsLocal
Whether or not the track is from a local file.
Boolean IsPlayable
Part of the response when Track Relinking is applied. If true, the track is playable in the given market. Otherwise false.
LinkedTrackObject LinkedFrom
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.
string ID
The Spotify ID for the track.
ExternalUrlObject ExternalUrls
Known external URLs for this track.
Boolean Published
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
string Spotify
The Spotify URL for the object.
string Href
A link to the Web API endpoint providing full details of the track.
Boolean Published
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
string Type
The object type: "track".
string Uri
The Spotify URI for the track.
string Name
The name of the track.
Long Popularity
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.
Deprecatedstring? PreviewUrl
A link to a 30 second preview (MP3 format) of the track. Can be null
Boolean Published
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
TrackRestrictionObject Restrictions
Included in the response when a content restriction is applied.
Boolean Published
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
string Reason
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.
Long TrackNumber
The number of the track. If an album has several discs, the track number is the number on the specified disc.
Type Type
The object type: "track".
string Uri
The Spotify URI for the track.
class TrackRestrictionObject:
Boolean Published
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
string Reason
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.