Create Playlist
Create a playlist for the current Spotify user. (The playlist will be empty until you add tracks.) Each user is generally limited to a maximum of 11000 playlists.
Request
- namestringRequired
The name for the new playlist, for example
"Your Coolest Playlist". This name does not need to be unique; a user may have several playlists with the same name. - publicboolean
Defaults to
true. The playlist's public/private status (if it should be added to the user's profile or not):truethe playlist will be public,falsethe playlist will be private. To be able to create private playlists, the user must have granted theplaylist-modify-privatescope. For more about public/private status, see Working with Playlists - collaborativeboolean
Defaults to
false. Iftruethe playlist will be collaborative. Note: to create a collaborative playlist you must also setpublictofalse. To create collaborative playlists you must have grantedplaylist-modify-privateandplaylist-modify-publicscopes. - descriptionstring
value for playlist description as displayed in Spotify Clients and in the Web API.
Response
A playlist
- collaborativeboolean
trueif the owner allows other users to modify the playlist. - descriptionstringNullable
The playlist description. Only returned for modified, verified playlists, otherwise
null. Known external URLs for this playlist.
- spotifystring
The Spotify URL for the object.
- hrefstring
A link to the Web API endpoint providing full details of the playlist.
- idstring
The Spotify ID for 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.- urlstringRequired
The source URL of the image.
Example:"https://i.scdn.co/image/ab67616d00001e02ff9ca10b55ce82ae553c8228" - heightintegerRequiredNullable
The image height in pixels.
Example:300 - widthintegerRequiredNullable
The image width in pixels.
Example:300
- namestring
The name of the playlist.
The user who owns the playlist
Known public external URLs for this user.
- spotifystring
The Spotify URL for the object.
- hrefstring
A link to the Web API endpoint for this user.
- idstring
The Spotify user ID for this user.
- typestring
The object type.
Allowed values:"user" - uristring
The Spotify URI for this user.
- display_namestringNullable
The name displayed on the user's profile.
nullif not available.
- publicboolean
The playlist's public/private status (if it is added to the user's profile):
truethe playlist is public,falsethe playlist is private,nullthe playlist status is not relevant. For more about public/private status, see Working with Playlists - snapshot_idstring
The version identifier for the current playlist. Can be supplied in other requests to target a specific playlist version
The items of the playlist. Note: This field is only available for playlists owned by the current user or playlists the user is a collaborator of.
- hrefstringRequired
A link to the Web API endpoint returning the full result of the request
Example:"https://api.spotify.com/v1/me/shows?offset=0&limit=20" - limitintegerRequired
The maximum number of items in the response (as set in the query or by default).
Example:20 - nextstringRequiredNullable
URL to the next page of items. (
nullif none)Example:"https://api.spotify.com/v1/me/shows?offset=1&limit=1" - offsetintegerRequired
The offset of the items returned (as set in the query or by default)
Example:0 - previousstringRequiredNullable
URL to the previous page of items. (
nullif none)Example:"https://api.spotify.com/v1/me/shows?offset=1&limit=1" - totalintegerRequired
The total number of items available to return.
Example:4 - Required
- added_atstring [date-time]
The date and time the track or episode was added. Note: some very old playlists may return
nullin this field. The Spotify user who added the track or episode. Note: some very old playlists may return
nullin this field.Known public external URLs for this user.
- spotifystring
The Spotify URL for the object.
- hrefstring
A link to the Web API endpoint for this user.
- idstring
The Spotify user ID for this user.
- typestring
The object type.
Allowed values:"user" - uristring
The Spotify URI for this user.
- is_localboolean
Whether this track or episode is a local file or not.
- itemoneOf
Information about the track or episode.
Will be one of the following:The album on which the track appears. The album object includes a link in
hrefto full information about the album.- album_typestringRequired
The type of the album.
Allowed values:"album","single","compilation"Example:"compilation" - total_tracksintegerRequired
The number of tracks in the album.
Example:9 - available_marketsarray of stringsRequiredDeprecated
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.
Example:["CA","BR","IT"] - Required
Known external URLs for this album.
- spotifystring
The Spotify URL for the object.
- hrefstringRequired
A link to the Web API endpoint providing full details of the album.
- idstringRequired
The Spotify ID for the album.
Example:"2up3OPMp9Tb4dAKM2erWXQ" - Required
The cover art for the album in various sizes, widest first.
- urlstringRequired
The source URL of the image.
Example:"https://i.scdn.co/image/ab67616d00001e02ff9ca10b55ce82ae553c8228" - heightintegerRequiredNullable
The image height in pixels.
Example:300 - widthintegerRequiredNullable
The image width in pixels.
Example:300
- namestringRequired
The name of the album. In case of an album takedown, the value may be an empty string.
- release_datestringRequired
The date the album was first released.
Example:"1981-12" - release_date_precisionstringRequired
The precision with which
release_datevalue is known.Allowed values:"year","month","day"Example:"year" Included in the response when a content restriction is applied.
- reasonstring
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.
Allowed values:"market","product","explicit"
- typestringRequired
The object type.
Allowed values:"album" - uristringRequired
The Spotify URI for the album.
Example:"spotify:album:2up3OPMp9Tb4dAKM2erWXQ" - Required
The artists of the album. Each artist object includes a link in
hrefto more detailed information about the artist.Known external URLs for this artist.
- spotifystring
The Spotify URL for the object.
- hrefstring
A link to the Web API endpoint providing full details of the artist.
- idstring
The Spotify ID for the artist.
- namestring
The name of the artist.
- typestring
The object type.
Allowed values:"artist" - uristring
The Spotify URI for the artist.
The artists who performed the track. Each artist object includes a link in
hrefto more detailed information about the artist.Known external URLs for this artist.
- spotifystring
The Spotify URL for the object.
- hrefstring
A link to the Web API endpoint providing full details of the artist.
- idstring
The Spotify ID for the artist.
- namestring
The name of the artist.
- typestring
The object type.
Allowed values:"artist" - uristring
The Spotify URI for the artist.
- available_marketsarray of stringsDeprecated
A list of the countries in which the track can be played, identified by their ISO 3166-1 alpha-2 code.
- disc_numberinteger
The disc number (usually
1unless the album consists of more than one disc). - duration_msinteger
The track length in milliseconds.
- explicitboolean
Whether or not the track has explicit lyrics (
true= yes it does;false= no it does not OR unknown). - Deprecated
Known external IDs for the track.
- isrcstring
- eanstring
- upcstring
Known external URLs for this track.
- spotifystring
The Spotify URL for the object.
- hrefstring
A link to the Web API endpoint providing full details of the track.
- idstring
The Spotify ID for the track.
- is_playableboolean
Part of the response when Track Relinking is applied. If
true, the track is playable in the given market. Otherwisefalse. - Deprecated
Part of the response when Track Relinking is applied, and the requested track has been replaced with different track. The track in the
linked_fromobject contains information about the originally requested track. Included in the response when a content restriction is applied.
- reasonstring
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.
- namestring
The name of the track.
- popularityintegerDeprecated
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. - preview_urlstringNullableDeprecated
A link to a 30 second preview (MP3 format) of the track. Can be
nullImportant policy noteAudio Preview Clips may not be offered as a standalone service or product.
More information
- track_numberinteger
The number of the track. If an album has several discs, the track number is the number on the specified disc.
- typestring
The object type: "track".
Allowed values:"track" - uristring
The Spotify URI for the track.
- is_localboolean
Whether or not the track is from a local file.
- audio_preview_urlstringRequiredNullableDeprecated
A URL to a 30 second preview (MP3 format) of the episode.
nullif not available.Important policy noteAudio Preview Clips may not be offered as a standalone service or product.
More information
Example:"https://p.scdn.co/mp3-preview/2f37da1d4221f40b9d1a98cd191f4d6f1646ad17" - descriptionstringRequired
A description of the episode. HTML tags are stripped away from this field, use
html_descriptionfield in case HTML tags are needed.Example:"A Spotify podcast sharing fresh insights on important topics of the moment—in a way only Spotify can. You’ll hear from experts in the music, podcast and tech industries as we discover and uncover stories about our work and the world around us." - html_descriptionstringRequired
A description of the episode. This field may contain HTML tags.
Example:"<p>A Spotify podcast sharing fresh insights on important topics of the moment—in a way only Spotify can. You’ll hear from experts in the music, podcast and tech industries as we discover and uncover stories about our work and the world around us.</p>" - duration_msintegerRequired
The episode length in milliseconds.
Example:1686230 - explicitbooleanRequired
Whether or not the episode has explicit content (true = yes it does; false = no it does not OR unknown).
- Required
External URLs for this episode.
- spotifystring
The Spotify URL for the object.
- hrefstringRequired
A link to the Web API endpoint providing full details of the episode.
Example:"https://api.spotify.com/v1/episodes/5Xt5DXGzch68nYYamXrNxZ" - idstringRequired
The Spotify ID for the episode.
Example:"5Xt5DXGzch68nYYamXrNxZ" - Required
The cover art for the episode in various sizes, widest first.
- urlstringRequired
The source URL of the image.
Example:"https://i.scdn.co/image/ab67616d00001e02ff9ca10b55ce82ae553c8228" - heightintegerRequiredNullable
The image height in pixels.
Example:300 - widthintegerRequiredNullable
The image width in pixels.
Example:300
- is_externally_hostedbooleanRequired
True if the episode is hosted outside of Spotify's CDN.
- is_playablebooleanRequired
True if the episode is playable in the given market. Otherwise false.
- languagestringDeprecated
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
languagesfield instead.Example:"en" - languagesarray of stringsRequired
A list of the languages used in the episode, identified by their ISO 639-1 code.
Example:["fr","en"] - namestringRequired
The name of the episode.
Example:"Starting Your Own Podcast: Tips, Tricks, and Advice From Anchor Creators" - release_datestringRequired
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".Example:"1981-12-15" - release_date_precisionstringRequired
The precision with which
release_datevalue is known.Allowed values:"year","month","day"Example:"day" The user's most recent position in the episode. Set if the supplied access token is a user token and has the scope 'user-read-playback-position'.
- fully_playedboolean
Whether or not the episode has been fully played by the user.
- resume_position_msinteger
The user's most recent position in the episode in milliseconds.
- typestringRequired
The object type.
Allowed values:"episode" - uristringRequired
The Spotify URI for the episode.
Example:"spotify:episode:0zLhl3WsOCQHbe1BPTiHgr" Included in the response when a content restriction is applied.
- reasonstring
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.
- Required
The show on which the episode belongs.
- available_marketsarray of stringsRequiredDeprecated
A list of the countries in which the show can be played, identified by their ISO 3166-1 alpha-2 code.
- Required
The copyright statements of the show.
- textstring
The copyright text for this content.
- typestring
The type of copyright:
C= the copyright,P= the sound recording (performance) copyright.
- descriptionstringRequired
A description of the show. HTML tags are stripped away from this field, use
html_descriptionfield in case HTML tags are needed. - html_descriptionstringRequired
A description of the show. This field may contain HTML tags.
- explicitbooleanRequired
Whether or not the show has explicit content (true = yes it does; false = no it does not OR unknown).
- Required
External URLs for this show.
- spotifystring
The Spotify URL for the object.
- hrefstringRequired
A link to the Web API endpoint providing full details of the show.
- idstringRequired
The Spotify ID for the show.
- Required
The cover art for the show in various sizes, widest first.
- urlstringRequired
The source URL of the image.
Example:"https://i.scdn.co/image/ab67616d00001e02ff9ca10b55ce82ae553c8228" - heightintegerRequiredNullable
The image height in pixels.
Example:300 - widthintegerRequiredNullable
The image width in pixels.
Example:300
- is_externally_hostedbooleanRequired
True if all of the shows episodes are hosted outside of Spotify's CDN. This field might be
nullin some cases. - languagesarray of stringsRequired
A list of the languages used in the show, identified by their ISO 639 code.
- media_typestringRequired
The media type of the show.
- namestringRequired
The name of the episode.
- publisherstringRequiredDeprecated
The publisher of the show.
- typestringRequired
The object type.
Allowed values:"show" - uristringRequired
The Spotify URI for the show.
- total_episodesintegerRequired
The total number of episodes in the show.
- trackoneOfDeprecated
Deprecated: Use
iteminstead. Information about the track or episode.Will be one of the following:The album on which the track appears. The album object includes a link in
hrefto full information about the album.- album_typestringRequired
The type of the album.
Allowed values:"album","single","compilation"Example:"compilation" - total_tracksintegerRequired
The number of tracks in the album.
Example:9 - available_marketsarray of stringsRequiredDeprecated
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.
Example:["CA","BR","IT"] - Required
Known external URLs for this album.
- spotifystring
The Spotify URL for the object.
- hrefstringRequired
A link to the Web API endpoint providing full details of the album.
- idstringRequired
The Spotify ID for the album.
Example:"2up3OPMp9Tb4dAKM2erWXQ" - Required
The cover art for the album in various sizes, widest first.
- urlstringRequired
The source URL of the image.
Example:"https://i.scdn.co/image/ab67616d00001e02ff9ca10b55ce82ae553c8228" - heightintegerRequiredNullable
The image height in pixels.
Example:300 - widthintegerRequiredNullable
The image width in pixels.
Example:300
- namestringRequired
The name of the album. In case of an album takedown, the value may be an empty string.
- release_datestringRequired
The date the album was first released.
Example:"1981-12" - release_date_precisionstringRequired
The precision with which
release_datevalue is known.Allowed values:"year","month","day"Example:"year" Included in the response when a content restriction is applied.
- reasonstring
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.
Allowed values:"market","product","explicit"
- typestringRequired
The object type.
Allowed values:"album" - uristringRequired
The Spotify URI for the album.
Example:"spotify:album:2up3OPMp9Tb4dAKM2erWXQ" - Required
The artists of the album. Each artist object includes a link in
hrefto more detailed information about the artist.Known external URLs for this artist.
- spotifystring
The Spotify URL for the object.
- hrefstring
A link to the Web API endpoint providing full details of the artist.
- idstring
The Spotify ID for the artist.
- namestring
The name of the artist.
- typestring
The object type.
Allowed values:"artist" - uristring
The Spotify URI for the artist.
The artists who performed the track. Each artist object includes a link in
hrefto more detailed information about the artist.Known external URLs for this artist.
- spotifystring
The Spotify URL for the object.
- hrefstring
A link to the Web API endpoint providing full details of the artist.
- idstring
The Spotify ID for the artist.
- namestring
The name of the artist.
- typestring
The object type.
Allowed values:"artist" - uristring
The Spotify URI for the artist.
- available_marketsarray of stringsDeprecated
A list of the countries in which the track can be played, identified by their ISO 3166-1 alpha-2 code.
- disc_numberinteger
The disc number (usually
1unless the album consists of more than one disc). - duration_msinteger
The track length in milliseconds.
- explicitboolean
Whether or not the track has explicit lyrics (
true= yes it does;false= no it does not OR unknown). - Deprecated
Known external IDs for the track.
- isrcstring
- eanstring
- upcstring
Known external URLs for this track.
- spotifystring
The Spotify URL for the object.
- hrefstring
A link to the Web API endpoint providing full details of the track.
- idstring
The Spotify ID for the track.
- is_playableboolean
Part of the response when Track Relinking is applied. If
true, the track is playable in the given market. Otherwisefalse. - Deprecated
Part of the response when Track Relinking is applied, and the requested track has been replaced with different track. The track in the
linked_fromobject contains information about the originally requested track. Included in the response when a content restriction is applied.
- reasonstring
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.
- namestring
The name of the track.
- popularityintegerDeprecated
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. - preview_urlstringNullableDeprecated
A link to a 30 second preview (MP3 format) of the track. Can be
nullImportant policy noteAudio Preview Clips may not be offered as a standalone service or product.
More information
- track_numberinteger
The number of the track. If an album has several discs, the track number is the number on the specified disc.
- typestring
The object type: "track".
Allowed values:"track" - uristring
The Spotify URI for the track.
- is_localboolean
Whether or not the track is from a local file.
- audio_preview_urlstringRequiredNullableDeprecated
A URL to a 30 second preview (MP3 format) of the episode.
nullif not available.Important policy noteAudio Preview Clips may not be offered as a standalone service or product.
More information
Example:"https://p.scdn.co/mp3-preview/2f37da1d4221f40b9d1a98cd191f4d6f1646ad17" - descriptionstringRequired
A description of the episode. HTML tags are stripped away from this field, use
html_descriptionfield in case HTML tags are needed.Example:"A Spotify podcast sharing fresh insights on important topics of the moment—in a way only Spotify can. You’ll hear from experts in the music, podcast and tech industries as we discover and uncover stories about our work and the world around us." - html_descriptionstringRequired
A description of the episode. This field may contain HTML tags.
Example:"<p>A Spotify podcast sharing fresh insights on important topics of the moment—in a way only Spotify can. You’ll hear from experts in the music, podcast and tech industries as we discover and uncover stories about our work and the world around us.</p>" - duration_msintegerRequired
The episode length in milliseconds.
Example:1686230 - explicitbooleanRequired
Whether or not the episode has explicit content (true = yes it does; false = no it does not OR unknown).
- Required
External URLs for this episode.
- spotifystring
The Spotify URL for the object.
- hrefstringRequired
A link to the Web API endpoint providing full details of the episode.
Example:"https://api.spotify.com/v1/episodes/5Xt5DXGzch68nYYamXrNxZ" - idstringRequired
The Spotify ID for the episode.
Example:"5Xt5DXGzch68nYYamXrNxZ" - Required
The cover art for the episode in various sizes, widest first.
- urlstringRequired
The source URL of the image.
Example:"https://i.scdn.co/image/ab67616d00001e02ff9ca10b55ce82ae553c8228" - heightintegerRequiredNullable
The image height in pixels.
Example:300 - widthintegerRequiredNullable
The image width in pixels.
Example:300
- is_externally_hostedbooleanRequired
True if the episode is hosted outside of Spotify's CDN.
- is_playablebooleanRequired
True if the episode is playable in the given market. Otherwise false.
- languagestringDeprecated
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
languagesfield instead.Example:"en" - languagesarray of stringsRequired
A list of the languages used in the episode, identified by their ISO 639-1 code.
Example:["fr","en"] - namestringRequired
The name of the episode.
Example:"Starting Your Own Podcast: Tips, Tricks, and Advice From Anchor Creators" - release_datestringRequired
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".Example:"1981-12-15" - release_date_precisionstringRequired
The precision with which
release_datevalue is known.Allowed values:"year","month","day"Example:"day" The user's most recent position in the episode. Set if the supplied access token is a user token and has the scope 'user-read-playback-position'.
- fully_playedboolean
Whether or not the episode has been fully played by the user.
- resume_position_msinteger
The user's most recent position in the episode in milliseconds.
- typestringRequired
The object type.
Allowed values:"episode" - uristringRequired
The Spotify URI for the episode.
Example:"spotify:episode:0zLhl3WsOCQHbe1BPTiHgr" Included in the response when a content restriction is applied.
- reasonstring
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.
- Required
The show on which the episode belongs.
- available_marketsarray of stringsRequiredDeprecated
A list of the countries in which the show can be played, identified by their ISO 3166-1 alpha-2 code.
- Required
The copyright statements of the show.
- textstring
The copyright text for this content.
- typestring
The type of copyright:
C= the copyright,P= the sound recording (performance) copyright.
- descriptionstringRequired
A description of the show. HTML tags are stripped away from this field, use
html_descriptionfield in case HTML tags are needed. - html_descriptionstringRequired
A description of the show. This field may contain HTML tags.
- explicitbooleanRequired
Whether or not the show has explicit content (true = yes it does; false = no it does not OR unknown).
- Required
External URLs for this show.
- spotifystring
The Spotify URL for the object.
- hrefstringRequired
A link to the Web API endpoint providing full details of the show.
- idstringRequired
The Spotify ID for the show.
- Required
The cover art for the show in various sizes, widest first.
- urlstringRequired
The source URL of the image.
Example:"https://i.scdn.co/image/ab67616d00001e02ff9ca10b55ce82ae553c8228" - heightintegerRequiredNullable
The image height in pixels.
Example:300 - widthintegerRequiredNullable
The image width in pixels.
Example:300
- is_externally_hostedbooleanRequired
True if all of the shows episodes are hosted outside of Spotify's CDN. This field might be
nullin some cases. - languagesarray of stringsRequired
A list of the languages used in the show, identified by their ISO 639 code.
- media_typestringRequired
The media type of the show.
- namestringRequired
The name of the episode.
- publisherstringRequiredDeprecated
The publisher of the show.
- typestringRequired
The object type.
Allowed values:"show" - uristringRequired
The Spotify URI for the show.
- total_episodesintegerRequired
The total number of episodes in the show.
- Deprecated
Deprecated: Use
itemsinstead. The tracks of the playlist.- hrefstringRequired
A link to the Web API endpoint returning the full result of the request
Example:"https://api.spotify.com/v1/me/shows?offset=0&limit=20" - limitintegerRequired
The maximum number of items in the response (as set in the query or by default).
Example:20 - nextstringRequiredNullable
URL to the next page of items. (
nullif none)Example:"https://api.spotify.com/v1/me/shows?offset=1&limit=1" - offsetintegerRequired
The offset of the items returned (as set in the query or by default)
Example:0 - previousstringRequiredNullable
URL to the previous page of items. (
nullif none)Example:"https://api.spotify.com/v1/me/shows?offset=1&limit=1" - totalintegerRequired
The total number of items available to return.
Example:4 - Required
- added_atstring [date-time]
The date and time the track or episode was added. Note: some very old playlists may return
nullin this field. The Spotify user who added the track or episode. Note: some very old playlists may return
nullin this field.Known public external URLs for this user.
- spotifystring
The Spotify URL for the object.
- hrefstring
A link to the Web API endpoint for this user.
- idstring
The Spotify user ID for this user.
- typestring
The object type.
Allowed values:"user" - uristring
The Spotify URI for this user.
- is_localboolean
Whether this track or episode is a local file or not.
- itemoneOf
Information about the track or episode.
Will be one of the following:The album on which the track appears. The album object includes a link in
hrefto full information about the album.- album_typestringRequired
The type of the album.
Allowed values:"album","single","compilation"Example:"compilation" - total_tracksintegerRequired
The number of tracks in the album.
Example:9 - available_marketsarray of stringsRequiredDeprecated
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.
Example:["CA","BR","IT"] - Required
Known external URLs for this album.
- spotifystring
The Spotify URL for the object.
- hrefstringRequired
A link to the Web API endpoint providing full details of the album.
- idstringRequired
The Spotify ID for the album.
Example:"2up3OPMp9Tb4dAKM2erWXQ" - Required
The cover art for the album in various sizes, widest first.
- urlstringRequired
The source URL of the image.
Example:"https://i.scdn.co/image/ab67616d00001e02ff9ca10b55ce82ae553c8228" - heightintegerRequiredNullable
The image height in pixels.
Example:300 - widthintegerRequiredNullable
The image width in pixels.
Example:300
- namestringRequired
The name of the album. In case of an album takedown, the value may be an empty string.
- release_datestringRequired
The date the album was first released.
Example:"1981-12" - release_date_precisionstringRequired
The precision with which
release_datevalue is known.Allowed values:"year","month","day"Example:"year" Included in the response when a content restriction is applied.
- reasonstring
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.
Allowed values:"market","product","explicit"
- typestringRequired
The object type.
Allowed values:"album" - uristringRequired
The Spotify URI for the album.
Example:"spotify:album:2up3OPMp9Tb4dAKM2erWXQ" - Required
The artists of the album. Each artist object includes a link in
hrefto more detailed information about the artist.Known external URLs for this artist.
- spotifystring
The Spotify URL for the object.
- hrefstring
A link to the Web API endpoint providing full details of the artist.
- idstring
The Spotify ID for the artist.
- namestring
The name of the artist.
- typestring
The object type.
Allowed values:"artist" - uristring
The Spotify URI for the artist.
The artists who performed the track. Each artist object includes a link in
hrefto more detailed information about the artist.Known external URLs for this artist.
- spotifystring
The Spotify URL for the object.
- hrefstring
A link to the Web API endpoint providing full details of the artist.
- idstring
The Spotify ID for the artist.
- namestring
The name of the artist.
- typestring
The object type.
Allowed values:"artist" - uristring
The Spotify URI for the artist.
- available_marketsarray of stringsDeprecated
A list of the countries in which the track can be played, identified by their ISO 3166-1 alpha-2 code.
- disc_numberinteger
The disc number (usually
1unless the album consists of more than one disc). - duration_msinteger
The track length in milliseconds.
- explicitboolean
Whether or not the track has explicit lyrics (
true= yes it does;false= no it does not OR unknown). - Deprecated
Known external IDs for the track.
- isrcstring
- eanstring
- upcstring
Known external URLs for this track.
- spotifystring
The Spotify URL for the object.
- hrefstring
A link to the Web API endpoint providing full details of the track.
- idstring
The Spotify ID for the track.
- is_playableboolean
Part of the response when Track Relinking is applied. If
true, the track is playable in the given market. Otherwisefalse. - Deprecated
Part of the response when Track Relinking is applied, and the requested track has been replaced with different track. The track in the
linked_fromobject contains information about the originally requested track. Included in the response when a content restriction is applied.
- reasonstring
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.
- namestring
The name of the track.
- popularityintegerDeprecated
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. - preview_urlstringNullableDeprecated
A link to a 30 second preview (MP3 format) of the track. Can be
nullImportant policy noteAudio Preview Clips may not be offered as a standalone service or product.
More information
- track_numberinteger
The number of the track. If an album has several discs, the track number is the number on the specified disc.
- typestring
The object type: "track".
Allowed values:"track" - uristring
The Spotify URI for the track.
- is_localboolean
Whether or not the track is from a local file.
- audio_preview_urlstringRequiredNullableDeprecated
A URL to a 30 second preview (MP3 format) of the episode.
nullif not available.Important policy noteAudio Preview Clips may not be offered as a standalone service or product.
More information
Example:"https://p.scdn.co/mp3-preview/2f37da1d4221f40b9d1a98cd191f4d6f1646ad17" - descriptionstringRequired
A description of the episode. HTML tags are stripped away from this field, use
html_descriptionfield in case HTML tags are needed.Example:"A Spotify podcast sharing fresh insights on important topics of the moment—in a way only Spotify can. You’ll hear from experts in the music, podcast and tech industries as we discover and uncover stories about our work and the world around us." - html_descriptionstringRequired
A description of the episode. This field may contain HTML tags.
Example:"<p>A Spotify podcast sharing fresh insights on important topics of the moment—in a way only Spotify can. You’ll hear from experts in the music, podcast and tech industries as we discover and uncover stories about our work and the world around us.</p>" - duration_msintegerRequired
The episode length in milliseconds.
Example:1686230 - explicitbooleanRequired
Whether or not the episode has explicit content (true = yes it does; false = no it does not OR unknown).
- Required
External URLs for this episode.
- spotifystring
The Spotify URL for the object.
- hrefstringRequired
A link to the Web API endpoint providing full details of the episode.
Example:"https://api.spotify.com/v1/episodes/5Xt5DXGzch68nYYamXrNxZ" - idstringRequired
The Spotify ID for the episode.
Example:"5Xt5DXGzch68nYYamXrNxZ" - Required
The cover art for the episode in various sizes, widest first.
- urlstringRequired
The source URL of the image.
Example:"https://i.scdn.co/image/ab67616d00001e02ff9ca10b55ce82ae553c8228" - heightintegerRequiredNullable
The image height in pixels.
Example:300 - widthintegerRequiredNullable
The image width in pixels.
Example:300
- is_externally_hostedbooleanRequired
True if the episode is hosted outside of Spotify's CDN.
- is_playablebooleanRequired
True if the episode is playable in the given market. Otherwise false.
- languagestringDeprecated
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
languagesfield instead.Example:"en" - languagesarray of stringsRequired
A list of the languages used in the episode, identified by their ISO 639-1 code.
Example:["fr","en"] - namestringRequired
The name of the episode.
Example:"Starting Your Own Podcast: Tips, Tricks, and Advice From Anchor Creators" - release_datestringRequired
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".Example:"1981-12-15" - release_date_precisionstringRequired
The precision with which
release_datevalue is known.Allowed values:"year","month","day"Example:"day" The user's most recent position in the episode. Set if the supplied access token is a user token and has the scope 'user-read-playback-position'.
- fully_playedboolean
Whether or not the episode has been fully played by the user.
- resume_position_msinteger
The user's most recent position in the episode in milliseconds.
- typestringRequired
The object type.
Allowed values:"episode" - uristringRequired
The Spotify URI for the episode.
Example:"spotify:episode:0zLhl3WsOCQHbe1BPTiHgr" Included in the response when a content restriction is applied.
- reasonstring
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.
- Required
The show on which the episode belongs.
- available_marketsarray of stringsRequiredDeprecated
A list of the countries in which the show can be played, identified by their ISO 3166-1 alpha-2 code.
- Required
The copyright statements of the show.
- textstring
The copyright text for this content.
- typestring
The type of copyright:
C= the copyright,P= the sound recording (performance) copyright.
- descriptionstringRequired
A description of the show. HTML tags are stripped away from this field, use
html_descriptionfield in case HTML tags are needed. - html_descriptionstringRequired
A description of the show. This field may contain HTML tags.
- explicitbooleanRequired
Whether or not the show has explicit content (true = yes it does; false = no it does not OR unknown).
- Required
External URLs for this show.
- spotifystring
The Spotify URL for the object.
- hrefstringRequired
A link to the Web API endpoint providing full details of the show.
- idstringRequired
The Spotify ID for the show.
- Required
The cover art for the show in various sizes, widest first.
- urlstringRequired
The source URL of the image.
Example:"https://i.scdn.co/image/ab67616d00001e02ff9ca10b55ce82ae553c8228" - heightintegerRequiredNullable
The image height in pixels.
Example:300 - widthintegerRequiredNullable
The image width in pixels.
Example:300
- is_externally_hostedbooleanRequired
True if all of the shows episodes are hosted outside of Spotify's CDN. This field might be
nullin some cases. - languagesarray of stringsRequired
A list of the languages used in the show, identified by their ISO 639 code.
- media_typestringRequired
The media type of the show.
- namestringRequired
The name of the episode.
- publisherstringRequiredDeprecated
The publisher of the show.
- typestringRequired
The object type.
Allowed values:"show" - uristringRequired
The Spotify URI for the show.
- total_episodesintegerRequired
The total number of episodes in the show.
- trackoneOfDeprecated
Deprecated: Use
iteminstead. Information about the track or episode.Will be one of the following:The album on which the track appears. The album object includes a link in
hrefto full information about the album.- album_typestringRequired
The type of the album.
Allowed values:"album","single","compilation"Example:"compilation" - total_tracksintegerRequired
The number of tracks in the album.
Example:9 - available_marketsarray of stringsRequiredDeprecated
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.
Example:["CA","BR","IT"] - Required
Known external URLs for this album.
- spotifystring
The Spotify URL for the object.
- hrefstringRequired
A link to the Web API endpoint providing full details of the album.
- idstringRequired
The Spotify ID for the album.
Example:"2up3OPMp9Tb4dAKM2erWXQ" - Required
The cover art for the album in various sizes, widest first.
- urlstringRequired
The source URL of the image.
Example:"https://i.scdn.co/image/ab67616d00001e02ff9ca10b55ce82ae553c8228" - heightintegerRequiredNullable
The image height in pixels.
Example:300 - widthintegerRequiredNullable
The image width in pixels.
Example:300
- namestringRequired
The name of the album. In case of an album takedown, the value may be an empty string.
- release_datestringRequired
The date the album was first released.
Example:"1981-12" - release_date_precisionstringRequired
The precision with which
release_datevalue is known.Allowed values:"year","month","day"Example:"year" Included in the response when a content restriction is applied.
- reasonstring
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.
Allowed values:"market","product","explicit"
- typestringRequired
The object type.
Allowed values:"album" - uristringRequired
The Spotify URI for the album.
Example:"spotify:album:2up3OPMp9Tb4dAKM2erWXQ" - Required
The artists of the album. Each artist object includes a link in
hrefto more detailed information about the artist.Known external URLs for this artist.
- spotifystring
The Spotify URL for the object.
- hrefstring
A link to the Web API endpoint providing full details of the artist.
- idstring
The Spotify ID for the artist.
- namestring
The name of the artist.
- typestring
The object type.
Allowed values:"artist" - uristring
The Spotify URI for the artist.
The artists who performed the track. Each artist object includes a link in
hrefto more detailed information about the artist.Known external URLs for this artist.
- spotifystring
The Spotify URL for the object.
- hrefstring
A link to the Web API endpoint providing full details of the artist.
- idstring
The Spotify ID for the artist.
- namestring
The name of the artist.
- typestring
The object type.
Allowed values:"artist" - uristring
The Spotify URI for the artist.
- available_marketsarray of stringsDeprecated
A list of the countries in which the track can be played, identified by their ISO 3166-1 alpha-2 code.
- disc_numberinteger
The disc number (usually
1unless the album consists of more than one disc). - duration_msinteger
The track length in milliseconds.
- explicitboolean
Whether or not the track has explicit lyrics (
true= yes it does;false= no it does not OR unknown). - Deprecated
Known external IDs for the track.
- isrcstring
- eanstring
- upcstring
Known external URLs for this track.
- spotifystring
The Spotify URL for the object.
- hrefstring
A link to the Web API endpoint providing full details of the track.
- idstring
The Spotify ID for the track.
- is_playableboolean
Part of the response when Track Relinking is applied. If
true, the track is playable in the given market. Otherwisefalse. - Deprecated
Part of the response when Track Relinking is applied, and the requested track has been replaced with different track. The track in the
linked_fromobject contains information about the originally requested track. Included in the response when a content restriction is applied.
- reasonstring
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.
- namestring
The name of the track.
- popularityintegerDeprecated
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. - preview_urlstringNullableDeprecated
A link to a 30 second preview (MP3 format) of the track. Can be
nullImportant policy noteAudio Preview Clips may not be offered as a standalone service or product.
More information
- track_numberinteger
The number of the track. If an album has several discs, the track number is the number on the specified disc.
- typestring
The object type: "track".
Allowed values:"track" - uristring
The Spotify URI for the track.
- is_localboolean
Whether or not the track is from a local file.
- audio_preview_urlstringRequiredNullableDeprecated
A URL to a 30 second preview (MP3 format) of the episode.
nullif not available.Important policy noteAudio Preview Clips may not be offered as a standalone service or product.
More information
Example:"https://p.scdn.co/mp3-preview/2f37da1d4221f40b9d1a98cd191f4d6f1646ad17" - descriptionstringRequired
A description of the episode. HTML tags are stripped away from this field, use
html_descriptionfield in case HTML tags are needed.Example:"A Spotify podcast sharing fresh insights on important topics of the moment—in a way only Spotify can. You’ll hear from experts in the music, podcast and tech industries as we discover and uncover stories about our work and the world around us." - html_descriptionstringRequired
A description of the episode. This field may contain HTML tags.
Example:"<p>A Spotify podcast sharing fresh insights on important topics of the moment—in a way only Spotify can. You’ll hear from experts in the music, podcast and tech industries as we discover and uncover stories about our work and the world around us.</p>" - duration_msintegerRequired
The episode length in milliseconds.
Example:1686230 - explicitbooleanRequired
Whether or not the episode has explicit content (true = yes it does; false = no it does not OR unknown).
- Required
External URLs for this episode.
- spotifystring
The Spotify URL for the object.
- hrefstringRequired
A link to the Web API endpoint providing full details of the episode.
Example:"https://api.spotify.com/v1/episodes/5Xt5DXGzch68nYYamXrNxZ" - idstringRequired
The Spotify ID for the episode.
Example:"5Xt5DXGzch68nYYamXrNxZ" - Required
The cover art for the episode in various sizes, widest first.
- urlstringRequired
The source URL of the image.
Example:"https://i.scdn.co/image/ab67616d00001e02ff9ca10b55ce82ae553c8228" - heightintegerRequiredNullable
The image height in pixels.
Example:300 - widthintegerRequiredNullable
The image width in pixels.
Example:300
- is_externally_hostedbooleanRequired
True if the episode is hosted outside of Spotify's CDN.
- is_playablebooleanRequired
True if the episode is playable in the given market. Otherwise false.
- languagestringDeprecated
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
languagesfield instead.Example:"en" - languagesarray of stringsRequired
A list of the languages used in the episode, identified by their ISO 639-1 code.
Example:["fr","en"] - namestringRequired
The name of the episode.
Example:"Starting Your Own Podcast: Tips, Tricks, and Advice From Anchor Creators" - release_datestringRequired
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".Example:"1981-12-15" - release_date_precisionstringRequired
The precision with which
release_datevalue is known.Allowed values:"year","month","day"Example:"day" The user's most recent position in the episode. Set if the supplied access token is a user token and has the scope 'user-read-playback-position'.
- fully_playedboolean
Whether or not the episode has been fully played by the user.
- resume_position_msinteger
The user's most recent position in the episode in milliseconds.
- typestringRequired
The object type.
Allowed values:"episode" - uristringRequired
The Spotify URI for the episode.
Example:"spotify:episode:0zLhl3WsOCQHbe1BPTiHgr" Included in the response when a content restriction is applied.
- reasonstring
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.
- Required
The show on which the episode belongs.
- available_marketsarray of stringsRequiredDeprecated
A list of the countries in which the show can be played, identified by their ISO 3166-1 alpha-2 code.
- Required
The copyright statements of the show.
- textstring
The copyright text for this content.
- typestring
The type of copyright:
C= the copyright,P= the sound recording (performance) copyright.
- descriptionstringRequired
A description of the show. HTML tags are stripped away from this field, use
html_descriptionfield in case HTML tags are needed. - html_descriptionstringRequired
A description of the show. This field may contain HTML tags.
- explicitbooleanRequired
Whether or not the show has explicit content (true = yes it does; false = no it does not OR unknown).
- Required
External URLs for this show.
- spotifystring
The Spotify URL for the object.
- hrefstringRequired
A link to the Web API endpoint providing full details of the show.
- idstringRequired
The Spotify ID for the show.
- Required
The cover art for the show in various sizes, widest first.
- urlstringRequired
The source URL of the image.
Example:"https://i.scdn.co/image/ab67616d00001e02ff9ca10b55ce82ae553c8228" - heightintegerRequiredNullable
The image height in pixels.
Example:300 - widthintegerRequiredNullable
The image width in pixels.
Example:300
- is_externally_hostedbooleanRequired
True if all of the shows episodes are hosted outside of Spotify's CDN. This field might be
nullin some cases. - languagesarray of stringsRequired
A list of the languages used in the show, identified by their ISO 639 code.
- media_typestringRequired
The media type of the show.
- namestringRequired
The name of the episode.
- publisherstringRequiredDeprecated
The publisher of the show.
- typestringRequired
The object type.
Allowed values:"show" - uristringRequired
The Spotify URI for the show.
- total_episodesintegerRequired
The total number of episodes in the show.
- typestring
The object type: "playlist"
- uristring
The Spotify URI for the playlist.