Shared
ModelsExpand Collapse
class AlbumRestrictionObject:
published: Optional<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: Optional<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:
id: Optional<String>
The Spotify ID for the artist.
Known external URLs for this artist.
published: Optional<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: Optional<String>
The Spotify URL for the object.
Information about the followers of the artist.
href: Optional<String>
This will always be set to null, as the Web API does not support it at the moment.
published: Optional<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: Optional<Long>
The total number of followers.
genres: Optional<List<String>>
A list of the genres the artist is associated with. If not yet classified, the array is empty.
href: Optional<String>
A link to the Web API endpoint providing full details of the artist.
Images of the artist in various sizes, widest first.
height: Optional<Long>
The image height in pixels.
url: String
The source URL of the image.
width: Optional<Long>
The image width in pixels.
published: Optional<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: Optional<String>
The name of the artist.
popularity: Optional<Long>
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: Optional<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: Optional<Type>
The object type.
uri: Optional<String>
The Spotify URI for the artist.
class AudiobookBase:
id: String
The Spotify ID for the audiobook.
The author(s) for the audiobook.
name: Optional<String>
The name of the author.
published: Optional<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
availableMarkets: List<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: Optional<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: Optional<String>
The copyright text for this content.
type: Optional<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: Optional<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: Optional<String>
The Spotify URL for the object.
href: String
A link to the Web API endpoint providing full details of the audiobook.
htmlDescription: String
A description of the audiobook. This field may contain HTML tags.
The cover art for the audiobook in various sizes, widest first.
height: Optional<Long>
The image height in pixels.
url: String
The source URL of the image.
width: Optional<Long>
The image width in pixels.
published: Optional<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: List<String>
A list of the languages used in the audiobook, identified by their ISO 639 code.
mediaType: String
The media type of the audiobook.
name: String
The name of the audiobook.
The narrator(s) for the audiobook.
name: Optional<String>
The name of the Narrator.
published: Optional<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.
totalChapters: Long
The number of chapters in this audiobook.
type: JsonValue; "audiobook"constant"audiobook"constant
The object type.
uri: String
The Spotify URI for the audiobook.
edition: Optional<String>
The edition of the audiobook.
published: Optional<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
class AuthorObject:
name: Optional<String>
The name of the author.
published: Optional<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
class ChapterRestrictionObject:
published: Optional<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: Optional<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.
class CopyrightObject:
published: Optional<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: Optional<String>
The copyright text for this content.
type: Optional<String>
The type of copyright: C = the copyright, P = the sound recording (performance) copyright.
class EpisodeObject:
id: String
The Spotify ID for the episode.
DeprecatedaudioPreviewUrl: Optional<String>
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.
durationMs: Long
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: Optional<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: Optional<String>
The Spotify URL for the object.
href: String
A link to the Web API endpoint providing full details of the episode.
htmlDescription: String
A description of the episode. This field may contain HTML tags.
The cover art for the episode in various sizes, widest first.
height: Optional<Long>
The image height in pixels.
url: String
The source URL of the image.
width: Optional<Long>
The image width in pixels.
published: Optional<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
isExternallyHosted: Boolean
True if the episode is hosted outside of Spotify's CDN.
isPlayable: Boolean
True if the episode is playable in the given market. Otherwise false.
languages: List<String>
A list of the languages used in the episode, identified by their ISO 639-1 code.
name: String
The name of the episode.
releaseDate: 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".
releaseDatePrecision: ReleaseDatePrecision
The precision with which release_date value is known.
The show on which the episode belongs.
id: String
The Spotify ID for the show.
availableMarkets: List<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: Optional<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: Optional<String>
The copyright text for this content.
type: Optional<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: Optional<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: Optional<String>
The Spotify URL for the object.
href: String
A link to the Web API endpoint providing full details of the show.
htmlDescription: String
A description of the show. This field may contain HTML tags.
The cover art for the show in various sizes, widest first.
height: Optional<Long>
The image height in pixels.
url: String
The source URL of the image.
width: Optional<Long>
The image width in pixels.
published: Optional<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
isExternallyHosted: Boolean
True if all of the shows episodes are hosted outside of Spotify's CDN. This field might be null in some cases.
languages: List<String>
A list of the languages used in the show, identified by their ISO 639 code.
mediaType: String
The media type of the show.
name: String
The name of the episode.
publisher: String
The publisher of the show.
totalEpisodes: Long
The total number of episodes in the show.
type: JsonValue; "show"constant"show"constant
The object type.
uri: String
The Spotify URI for the show.
published: Optional<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: JsonValue; "episode"constant"episode"constant
The object type.
uri: String
The Spotify URI for the episode.
Deprecatedlanguage: Optional<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: Optional<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: Optional<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: Optional<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'.
fullyPlayed: Optional<Boolean>
Whether or not the episode has been fully played by the user.
published: Optional<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
resumePositionMs: Optional<Long>
The user's most recent position in the episode in milliseconds.
class EpisodeRestrictionObject:
published: Optional<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: Optional<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.
class ExternalIdObject:
ean: Optional<String>
isrc: Optional<String>
published: Optional<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: Optional<String>
class ExternalUrlObject:
published: Optional<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: Optional<String>
The Spotify URL for the object.
class FollowersObject:
href: Optional<String>
This will always be set to null, as the Web API does not support it at the moment.
published: Optional<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: Optional<Long>
The total number of followers.
class ImageObject:
height: Optional<Long>
The image height in pixels.
url: String
The source URL of the image.
width: Optional<Long>
The image width in pixels.
published: Optional<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
class LinkedTrackObject:
id: Optional<String>
The Spotify ID for the track.
Known external URLs for this track.
published: Optional<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: Optional<String>
The Spotify URL for the object.
href: Optional<String>
A link to the Web API endpoint providing full details of the track.
published: Optional<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: Optional<String>
The object type: "track".
uri: Optional<String>
The Spotify URI for the track.
class NarratorObject:
name: Optional<String>
The name of the Narrator.
published: Optional<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
class PagingPlaylistObject:
href: String
A link to the Web API endpoint returning the full result of the request
limit: Long
The maximum number of items in the response (as set in the query or by default).
next: Optional<String>
URL to the next page of items. ( null if none)
offset: Long
The offset of the items returned (as set in the query or by default)
previous: Optional<String>
URL to the previous page of items. ( null if none)
total: Long
The total number of items available to return.
id: Optional<String>
The Spotify ID for the playlist.
collaborative: Optional<Boolean>
true if the owner allows other users to modify the playlist.
description: Optional<String>
The playlist description. Only returned for modified, verified playlists, otherwise null.
Known external URLs for this playlist.
published: Optional<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: Optional<String>
The Spotify URL for the object.
href: Optional<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: Optional<Long>
The image height in pixels.
url: String
The source URL of the image.
width: Optional<Long>
The image width in pixels.
published: Optional<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: Optional<String>
The name of the playlist.
owner: Optional<Owner>
The user who owns the playlist
displayName: Optional<String>
The name displayed on the user's profile. null if not available.
published: Optional<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
snapshotId: Optional<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: Optional<String>
A link to the Web API endpoint where full details of the playlist's tracks can be retrieved.
published: Optional<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: Optional<Long>
Number of tracks in the playlist.
type: Optional<String>
The object type: "playlist"
uri: Optional<String>
The Spotify URI for the playlist.
published: Optional<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
class PlaylistTrackObject:
addedAt: Optional<LocalDateTime>
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: Optional<String>
The Spotify user ID for this user.
Known public external URLs for this user.
published: Optional<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: Optional<String>
The Spotify URL for the object.
href: Optional<String>
A link to the Web API endpoint for this user.
published: Optional<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: Optional<Type>
The object type.
uri: Optional<String>
The Spotify URI for this user.
isLocal: Optional<Boolean>
Whether this track or episode is a local file or not.
published: Optional<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: Optional<Track>
Information about the track or episode.
class TrackObject:
id: Optional<String>
The Spotify ID for the track.
album: Optional<Album>
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.
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.
id: Optional<String>
The Spotify ID for the artist.
Known external URLs for this artist.
published: Optional<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: Optional<String>
The Spotify URL for the object.
href: Optional<String>
A link to the Web API endpoint providing full details of the artist.
name: Optional<String>
The name of the artist.
published: Optional<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: Optional<Type>
The object type.
uri: Optional<String>
The Spotify URI for the artist.
availableMarkets: List<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: Optional<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: Optional<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: Optional<Long>
The image height in pixels.
url: String
The source URL of the image.
width: Optional<Long>
The image width in pixels.
published: Optional<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.
releaseDate: String
The date the album was first released.
releaseDatePrecision: ReleaseDatePrecision
The precision with which release_date value is known.
totalTracks: Long
The number of tracks in the album.
type: JsonValue; "album"constant"album"constant
The object type.
uri: String
The Spotify URI for the album.
published: Optional<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: Optional<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: Optional<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.
The artists who performed the track. Each artist object includes a link in href to more detailed information about the artist.
id: Optional<String>
The Spotify ID for the artist.
Known external URLs for this artist.
published: Optional<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: Optional<String>
The Spotify URL for the object.
href: Optional<String>
A link to the Web API endpoint providing full details of the artist.
name: Optional<String>
The name of the artist.
published: Optional<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: Optional<Type>
The object type.
uri: Optional<String>
The Spotify URI for the artist.
availableMarkets: Optional<List<String>>
A list of the countries in which the track can be played, identified by their ISO 3166-1 alpha-2 code.
discNumber: Optional<Long>
The disc number (usually 1 unless the album consists of more than one disc).
durationMs: Optional<Long>
The track length in milliseconds.
explicit: Optional<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: Optional<String>
isrc: Optional<String>
published: Optional<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: Optional<String>
Known external URLs for this track.
published: Optional<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: Optional<String>
The Spotify URL for the object.
href: Optional<String>
A link to the Web API endpoint providing full details of the track.
isLocal: Optional<Boolean>
Whether or not the track is from a local file.
isPlayable: Optional<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: Optional<String>
The Spotify ID for the track.
Known external URLs for this track.
published: Optional<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: Optional<String>
The Spotify URL for the object.
href: Optional<String>
A link to the Web API endpoint providing full details of the track.
published: Optional<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: Optional<String>
The object type: "track".
uri: Optional<String>
The Spotify URI for the track.
name: Optional<String>
The name of the track.
popularity: Optional<Long>
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.
DeprecatedpreviewUrl: Optional<String>
A link to a 30 second preview (MP3 format) of the track. Can be null
published: Optional<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: Optional<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: Optional<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.
trackNumber: Optional<Long>
The number of the track. If an album has several discs, the track number is the number on the specified disc.
type: Optional<Type>
The object type: "track".
uri: Optional<String>
The Spotify URI for the track.
class EpisodeObject:
id: String
The Spotify ID for the episode.
DeprecatedaudioPreviewUrl: Optional<String>
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.
durationMs: Long
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: Optional<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: Optional<String>
The Spotify URL for the object.
href: String
A link to the Web API endpoint providing full details of the episode.
htmlDescription: String
A description of the episode. This field may contain HTML tags.
The cover art for the episode in various sizes, widest first.
height: Optional<Long>
The image height in pixels.
url: String
The source URL of the image.
width: Optional<Long>
The image width in pixels.
published: Optional<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
isExternallyHosted: Boolean
True if the episode is hosted outside of Spotify's CDN.
isPlayable: Boolean
True if the episode is playable in the given market. Otherwise false.
languages: List<String>
A list of the languages used in the episode, identified by their ISO 639-1 code.
name: String
The name of the episode.
releaseDate: 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".
releaseDatePrecision: ReleaseDatePrecision
The precision with which release_date value is known.
The show on which the episode belongs.
id: String
The Spotify ID for the show.
availableMarkets: List<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: Optional<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: Optional<String>
The copyright text for this content.
type: Optional<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: Optional<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: Optional<String>
The Spotify URL for the object.
href: String
A link to the Web API endpoint providing full details of the show.
htmlDescription: String
A description of the show. This field may contain HTML tags.
The cover art for the show in various sizes, widest first.
height: Optional<Long>
The image height in pixels.
url: String
The source URL of the image.
width: Optional<Long>
The image width in pixels.
published: Optional<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
isExternallyHosted: Boolean
True if all of the shows episodes are hosted outside of Spotify's CDN. This field might be null in some cases.
languages: List<String>
A list of the languages used in the show, identified by their ISO 639 code.
mediaType: String
The media type of the show.
name: String
The name of the episode.
publisher: String
The publisher of the show.
totalEpisodes: Long
The total number of episodes in the show.
type: JsonValue; "show"constant"show"constant
The object type.
uri: String
The Spotify URI for the show.
published: Optional<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: JsonValue; "episode"constant"episode"constant
The object type.
uri: String
The Spotify URI for the episode.
Deprecatedlanguage: Optional<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: Optional<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: Optional<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: Optional<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'.
fullyPlayed: Optional<Boolean>
Whether or not the episode has been fully played by the user.
published: Optional<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
resumePositionMs: Optional<Long>
The user's most recent position in the episode in milliseconds.
class PlaylistTracksRefObject:
href: Optional<String>
A link to the Web API endpoint where full details of the playlist's tracks can be retrieved.
published: Optional<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: Optional<Long>
Number of tracks in the playlist.
class PlaylistUserObject:
id: Optional<String>
The Spotify user ID for this user.
Known public external URLs for this user.
published: Optional<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: Optional<String>
The Spotify URL for the object.
href: Optional<String>
A link to the Web API endpoint for this user.
published: Optional<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: Optional<Type>
The object type.
uri: Optional<String>
The Spotify URI for this user.
class ResumePointObject:
fullyPlayed: Optional<Boolean>
Whether or not the episode has been fully played by the user.
published: Optional<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
resumePositionMs: Optional<Long>
The user's most recent position in the episode in milliseconds.
class ShowBase:
id: String
The Spotify ID for the show.
availableMarkets: List<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: Optional<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: Optional<String>
The copyright text for this content.
type: Optional<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: Optional<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: Optional<String>
The Spotify URL for the object.
href: String
A link to the Web API endpoint providing full details of the show.
htmlDescription: String
A description of the show. This field may contain HTML tags.
The cover art for the show in various sizes, widest first.
height: Optional<Long>
The image height in pixels.
url: String
The source URL of the image.
width: Optional<Long>
The image width in pixels.
published: Optional<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
isExternallyHosted: Boolean
True if all of the shows episodes are hosted outside of Spotify's CDN. This field might be null in some cases.
languages: List<String>
A list of the languages used in the show, identified by their ISO 639 code.
mediaType: String
The media type of the show.
name: String
The name of the episode.
publisher: String
The publisher of the show.
totalEpisodes: Long
The total number of episodes in the show.
type: JsonValue; "show"constant"show"constant
The object type.
uri: String
The Spotify URI for the show.
published: Optional<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
class SimplifiedArtistObject:
id: Optional<String>
The Spotify ID for the artist.
Known external URLs for this artist.
published: Optional<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: Optional<String>
The Spotify URL for the object.
href: Optional<String>
A link to the Web API endpoint providing full details of the artist.
name: Optional<String>
The name of the artist.
published: Optional<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: Optional<Type>
The object type.
uri: Optional<String>
The Spotify URI for the artist.
class SimplifiedEpisodeObject:
id: String
The Spotify ID for the episode.
DeprecatedaudioPreviewUrl: Optional<String>
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.
durationMs: Long
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: Optional<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: Optional<String>
The Spotify URL for the object.
href: String
A link to the Web API endpoint providing full details of the episode.
htmlDescription: String
A description of the episode. This field may contain HTML tags.
The cover art for the episode in various sizes, widest first.
height: Optional<Long>
The image height in pixels.
url: String
The source URL of the image.
width: Optional<Long>
The image width in pixels.
published: Optional<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
isExternallyHosted: Boolean
True if the episode is hosted outside of Spotify's CDN.
isPlayable: Boolean
True if the episode is playable in the given market. Otherwise false.
languages: List<String>
A list of the languages used in the episode, identified by their ISO 639-1 code.
name: String
The name of the episode.
releaseDate: 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".
releaseDatePrecision: ReleaseDatePrecision
The precision with which release_date value is known.
type: JsonValue; "episode"constant"episode"constant
The object type.
uri: String
The Spotify URI for the episode.
Deprecatedlanguage: Optional<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: Optional<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: Optional<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: Optional<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'.
fullyPlayed: Optional<Boolean>
Whether or not the episode has been fully played by the user.
published: Optional<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
resumePositionMs: Optional<Long>
The user's most recent position in the episode in milliseconds.
class SimplifiedPlaylistObject:
id: Optional<String>
The Spotify ID for the playlist.
collaborative: Optional<Boolean>
true if the owner allows other users to modify the playlist.
description: Optional<String>
The playlist description. Only returned for modified, verified playlists, otherwise null.
Known external URLs for this playlist.
published: Optional<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: Optional<String>
The Spotify URL for the object.
href: Optional<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: Optional<Long>
The image height in pixels.
url: String
The source URL of the image.
width: Optional<Long>
The image width in pixels.
published: Optional<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: Optional<String>
The name of the playlist.
owner: Optional<Owner>
The user who owns the playlist
displayName: Optional<String>
The name displayed on the user's profile. null if not available.
published: Optional<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
snapshotId: Optional<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: Optional<String>
A link to the Web API endpoint where full details of the playlist's tracks can be retrieved.
published: Optional<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: Optional<Long>
Number of tracks in the playlist.
type: Optional<String>
The object type: "playlist"
uri: Optional<String>
The Spotify URI for the playlist.
class SimplifiedTrackObject:
id: Optional<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: Optional<String>
The Spotify ID for the artist.
Known external URLs for this artist.
published: Optional<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: Optional<String>
The Spotify URL for the object.
href: Optional<String>
A link to the Web API endpoint providing full details of the artist.
name: Optional<String>
The name of the artist.
published: Optional<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: Optional<Type>
The object type.
uri: Optional<String>
The Spotify URI for the artist.
availableMarkets: Optional<List<String>>
A list of the countries in which the track can be played, identified by their ISO 3166-1 alpha-2 code.
discNumber: Optional<Long>
The disc number (usually 1 unless the album consists of more than one disc).
durationMs: Optional<Long>
The track length in milliseconds.
explicit: Optional<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: Optional<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: Optional<String>
The Spotify URL for the object.
href: Optional<String>
A link to the Web API endpoint providing full details of the track.
isLocal: Optional<Boolean>
Whether or not the track is from a local file.
isPlayable: Optional<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: Optional<String>
The Spotify ID for the track.
Known external URLs for this track.
published: Optional<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: Optional<String>
The Spotify URL for the object.
href: Optional<String>
A link to the Web API endpoint providing full details of the track.
published: Optional<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: Optional<String>
The object type: "track".
uri: Optional<String>
The Spotify URI for the track.
name: Optional<String>
The name of the track.
DeprecatedpreviewUrl: Optional<String>
A URL to a 30 second preview (MP3 format) of the track.
published: Optional<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: Optional<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: Optional<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.
trackNumber: Optional<Long>
The number of the track. If an album has several discs, the track number is the number on the specified disc.
type: Optional<String>
The object type: "track".
uri: Optional<String>
The Spotify URI for the track.
class TrackObject:
id: Optional<String>
The Spotify ID for the track.
album: Optional<Album>
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.
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.
id: Optional<String>
The Spotify ID for the artist.
Known external URLs for this artist.
published: Optional<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: Optional<String>
The Spotify URL for the object.
href: Optional<String>
A link to the Web API endpoint providing full details of the artist.
name: Optional<String>
The name of the artist.
published: Optional<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: Optional<Type>
The object type.
uri: Optional<String>
The Spotify URI for the artist.
availableMarkets: List<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: Optional<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: Optional<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: Optional<Long>
The image height in pixels.
url: String
The source URL of the image.
width: Optional<Long>
The image width in pixels.
published: Optional<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.
releaseDate: String
The date the album was first released.
releaseDatePrecision: ReleaseDatePrecision
The precision with which release_date value is known.
totalTracks: Long
The number of tracks in the album.
type: JsonValue; "album"constant"album"constant
The object type.
uri: String
The Spotify URI for the album.
published: Optional<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: Optional<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: Optional<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.
The artists who performed the track. Each artist object includes a link in href to more detailed information about the artist.
id: Optional<String>
The Spotify ID for the artist.
Known external URLs for this artist.
published: Optional<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: Optional<String>
The Spotify URL for the object.
href: Optional<String>
A link to the Web API endpoint providing full details of the artist.
name: Optional<String>
The name of the artist.
published: Optional<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: Optional<Type>
The object type.
uri: Optional<String>
The Spotify URI for the artist.
availableMarkets: Optional<List<String>>
A list of the countries in which the track can be played, identified by their ISO 3166-1 alpha-2 code.
discNumber: Optional<Long>
The disc number (usually 1 unless the album consists of more than one disc).
durationMs: Optional<Long>
The track length in milliseconds.
explicit: Optional<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: Optional<String>
isrc: Optional<String>
published: Optional<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: Optional<String>
Known external URLs for this track.
published: Optional<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: Optional<String>
The Spotify URL for the object.
href: Optional<String>
A link to the Web API endpoint providing full details of the track.
isLocal: Optional<Boolean>
Whether or not the track is from a local file.
isPlayable: Optional<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: Optional<String>
The Spotify ID for the track.
Known external URLs for this track.
published: Optional<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: Optional<String>
The Spotify URL for the object.
href: Optional<String>
A link to the Web API endpoint providing full details of the track.
published: Optional<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: Optional<String>
The object type: "track".
uri: Optional<String>
The Spotify URI for the track.
name: Optional<String>
The name of the track.
popularity: Optional<Long>
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.
DeprecatedpreviewUrl: Optional<String>
A link to a 30 second preview (MP3 format) of the track. Can be null
published: Optional<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: Optional<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: Optional<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.
trackNumber: Optional<Long>
The number of the track. If an album has several discs, the track number is the number on the specified disc.
type: Optional<Type>
The object type: "track".
uri: Optional<String>
The Spotify URI for the track.
class TrackRestrictionObject:
published: Optional<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: Optional<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.