Get Playlist

PlaylistRetrieveResponse playlists().retrieve(, )

GET/playlists/{playlist_id}

Get a playlist owned by a Spotify user.

ParametersExpand Collapse

PlaylistRetrieveParams params

Optional<String> playlistId

The Spotify ID of the playlist.

Optional<String> additionalTypes

A comma-separated list of item types that your client supports besides the default track type. Valid types are: track and episode.
Note: This parameter was introduced to allow existing clients to maintain their current behaviour and might be deprecated in the future.
In addition to providing this parameter, make sure that your client properly handles cases of new types in the future by checking against the type field of each object.

Optional<String> fields

Filters for the query: a comma-separated list of the fields to return. If omitted, all fields are returned. For example, to get just the playlist''s description and URI: fields=description,uri. A dot separator can be used to specify non-reoccurring fields, while parentheses can be used to specify reoccurring fields within objects. For example, to get just the added date and user ID of the adder: fields=tracks.items(added_at,added_by.id). Use multiple parentheses to drill down into nested objects, for example: fields=tracks.items(track(name,href,album(name,href))). Fields can be excluded by prefixing them with an exclamation mark, for example: fields=tracks.items(track(name,href,album(!name,href)))

Optional<String> market

An ISO 3166-1 alpha-2 country code. If a country code is specified, only content that is available in that market will be returned.
If a valid user access token is specified in the request header, the country associated with the user account will take priority over this parameter.
Note: If neither market or user country are provided, the content is considered unavailable for the client.
Users can view the country that is associated with their account in the account settings.

ReturnsExpand Collapse

class PlaylistRetrieveResponse:

Optional<String> id

The Spotify ID for the playlist.

Optional<Boolean> collaborative

true if the owner allows other users to modify the playlist.

Optional<String> description

The playlist description. Only returned for modified, verified playlists, otherwise null.

Optional<ExternalUrlObject> externalUrls

Known external URLs for this playlist.

Optional<Boolean> published

The playlist's public/private status (if it should be added to the user's profile or not): true the playlist will be public, false the playlist will be private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists

Optional<String> spotify

The Spotify URL for the object.

Optional<FollowersObject> followers

Information about the followers of the playlist.

Optional<String> href

This will always be set to null, as the Web API does not support it at the moment.

Optional<Boolean> published

Optional<Long> total

The total number of followers.

Optional<String> href

A link to the Web API endpoint providing full details of the playlist.

Optional<List<ImageObject>> images

Images for the playlist. The array may be empty or contain up to three images. The images are returned by size in descending order. See Working with Playlists. Note: If returned, the source URL for the image (url) is temporary and will expire in less than a day.

Optional<Long> height

The image height in pixels.

String url

The source URL of the image.

Optional<Long> width

The image width in pixels.

Optional<Boolean> published

Optional<String> name

The name of the playlist.

Optional<Owner> owner

The user who owns the playlist

Optional<String> displayName

The name displayed on the user's profile. null if not available.

Optional<Boolean> published

Optional<String> snapshotId

The version identifier for the current playlist. Can be supplied in other requests to target a specific playlist version

Optional<Tracks> tracks

The tracks of the playlist.

String href

A link to the Web API endpoint returning the full result of the request

long limit

The maximum number of items in the response (as set in the query or by default).

Optional<String> next

URL to the next page of items. ( null if none)

long offset

The offset of the items returned (as set in the query or by default)

Optional<String> previous

URL to the previous page of items. ( null if none)

long total

The total number of items available to return.

Optional<List<PlaylistTrackObject>> items

Optional<LocalDateTime> addedAt

The date and time the track or episode was added. Note: some very old playlists may return null in this field.

formatdate-time

Optional<PlaylistUserObject> addedBy

The Spotify user who added the track or episode. Note: some very old playlists may return null in this field.

Optional<String> id

The Spotify user ID for this user.

Optional<ExternalUrlObject> externalUrls

Known public external URLs for this user.

Optional<Boolean> published

Optional<String> spotify

The Spotify URL for the object.

Optional<String> href

A link to the Web API endpoint for this user.

Optional<Boolean> published

Optional<Type> type

The object type.

Optional<String> uri

The Spotify URI for this user.

Optional<Boolean> isLocal

Whether this track or episode is a local file or not.

Optional<Boolean> published

Optional<Track> track

Information about the track or episode.

Accepts one of the following:

class TrackObject:

Optional<String> id

The Spotify ID for the track.

Optional<Album> album

The album on which the track appears. The album object includes a link in href to full information about the album.

String id

The Spotify ID for the album.

AlbumType albumType

The type of the album.

Accepts one of the following:

ALBUM("album")

SINGLE("single")

COMPILATION("compilation")

List<SimplifiedArtistObject> artists

The artists of the album. Each artist object includes a link in href to more detailed information about the artist.

Optional<String> id

The Spotify ID for the artist.

Optional<ExternalUrlObject> externalUrls

Known external URLs for this artist.

Optional<Boolean> published

Optional<String> spotify

The Spotify URL for the object.

Optional<String> href

A link to the Web API endpoint providing full details of the artist.

Optional<String> name

The name of the artist.

Optional<Boolean> published

Optional<Type> type

The object type.

Optional<String> uri

The Spotify URI for the artist.

List<String> availableMarkets

The markets in which the album is available: ISO 3166-1 alpha-2 country codes. NOTE: an album is considered available in a market when at least 1 of its tracks is available in that market.

ExternalUrlObject externalUrls

Known external URLs for this album.

Optional<Boolean> published

Optional<String> spotify

The Spotify URL for the object.

String href

A link to the Web API endpoint providing full details of the album.

List<ImageObject> images

The cover art for the album in various sizes, widest first.

Optional<Long> height

The image height in pixels.

String url

The source URL of the image.

Optional<Long> width

The image width in pixels.

Optional<Boolean> published

String name

The name of the album. In case of an album takedown, the value may be an empty string.

String releaseDate

The date the album was first released.

ReleaseDatePrecision releaseDatePrecision

The precision with which release_date value is known.

Accepts one of the following:

YEAR("year")

MONTH("month")

DAY("day")

long totalTracks

The number of tracks in the album.

JsonValue; type

The object type.

String uri

The Spotify URI for the album.

Optional<Boolean> published

Optional<AlbumRestrictionObject> restrictions

Included in the response when a content restriction is applied.

Optional<Boolean> published

Optional<Reason> reason

The reason for the restriction. Albums may be restricted if the content is not available in a given market, to the user's subscription type, or when the user's account is set to not play explicit content. Additional reasons may be added in the future.

Accepts one of the following:

MARKET("market")

PRODUCT("product")

EXPLICIT("explicit")

Optional<List<SimplifiedArtistObject>> artists

The artists who performed the track. Each artist object includes a link in href to more detailed information about the artist.

Optional<String> id

The Spotify ID for the artist.

Optional<ExternalUrlObject> externalUrls

Known external URLs for this artist.

Optional<Boolean> published

Optional<String> spotify

The Spotify URL for the object.

Optional<String> href

A link to the Web API endpoint providing full details of the artist.

Optional<String> name

The name of the artist.

Optional<Boolean> published

Optional<Type> type

The object type.

Optional<String> uri

The Spotify URI for the artist.

Optional<List<String>> availableMarkets

A list of the countries in which the track can be played, identified by their ISO 3166-1 alpha-2 code.

Optional<Long> discNumber

The disc number (usually 1 unless the album consists of more than one disc).

Optional<Long> durationMs

The track length in milliseconds.

Optional<Boolean> explicit

Whether or not the track has explicit lyrics ( true = yes it does; false = no it does not OR unknown).

Optional<ExternalIdObject> externalIds

Known external IDs for the track.

Optional<String> ean

International Article Number

Optional<String> isrc

International Standard Recording Code

Optional<Boolean> published

Optional<String> upc

Universal Product Code

Optional<ExternalUrlObject> externalUrls

Known external URLs for this track.

Optional<Boolean> published

Optional<String> spotify

The Spotify URL for the object.

Optional<String> href

A link to the Web API endpoint providing full details of the track.

Optional<Boolean> isLocal

Whether or not the track is from a local file.

Optional<Boolean> isPlayable

Part of the response when Track Relinking is applied. If true, the track is playable in the given market. Otherwise false.

Optional<LinkedTrackObject> linkedFrom

Part of the response when Track Relinking is applied, and the requested track has been replaced with different track. The track in the linked_from object contains information about the originally requested track.

Optional<String> id

The Spotify ID for the track.

Optional<ExternalUrlObject> externalUrls

Known external URLs for this track.

Optional<Boolean> published

Optional<String> spotify

The Spotify URL for the object.

Optional<String> href

A link to the Web API endpoint providing full details of the track.

Optional<Boolean> published

Optional<String> type

The object type: "track".

Optional<String> uri

The Spotify URI for the track.

Optional<String> name

The name of the track.

Optional<Long> popularity

The popularity of the track. The value will be between 0 and 100, with 100 being the most popular.
The popularity of a track is a value between 0 and 100, with 100 being the most popular. The popularity is calculated by algorithm and is based, in the most part, on the total number of plays the track has had and how recent those plays are.
Generally speaking, songs that are being played a lot now will have a higher popularity than songs that were played a lot in the past. Duplicate tracks (e.g. the same track from a single and an album) are rated independently. Artist and album popularity is derived mathematically from track popularity. Note: the popularity value may lag actual popularity by a few days: the value is not updated in real time.

DeprecatedOptional<String> previewUrl

A link to a 30 second preview (MP3 format) of the track. Can be null

Optional<Boolean> published

Optional<TrackRestrictionObject> restrictions

Included in the response when a content restriction is applied.

Optional<Boolean> published

Optional<String> reason

The reason for the restriction. Supported values:

market - The content item is not available in the given market.
product - The content item is not available for the user's subscription type.
explicit - The content item is explicit and the user's account is set to not play explicit content.

Additional reasons may be added in the future. Note: If you use this field, make sure that your application safely handles unknown values.

Optional<Long> trackNumber

The number of the track. If an album has several discs, the track number is the number on the specified disc.

Optional<Type> type

The object type: "track".

Optional<String> uri

The Spotify URI for the track.

class EpisodeObject:

String id

The Spotify ID for the episode.

DeprecatedOptional<String> audioPreviewUrl

A URL to a 30 second preview (MP3 format) of the episode. null if not available.

String description

A description of the episode. HTML tags are stripped away from this field, use html_description field in case HTML tags are needed.

long durationMs

The episode length in milliseconds.

boolean explicit

Whether or not the episode has explicit content (true = yes it does; false = no it does not OR unknown).

ExternalUrlObject externalUrls

External URLs for this episode.

Optional<Boolean> published

Optional<String> spotify

The Spotify URL for the object.

String href

A link to the Web API endpoint providing full details of the episode.

String htmlDescription

A description of the episode. This field may contain HTML tags.

List<ImageObject> images

The cover art for the episode in various sizes, widest first.

Optional<Long> height

The image height in pixels.

String url

The source URL of the image.

Optional<Long> width

The image width in pixels.

Optional<Boolean> published

boolean isExternallyHosted

True if the episode is hosted outside of Spotify's CDN.

boolean isPlayable

True if the episode is playable in the given market. Otherwise false.

List<String> languages

A list of the languages used in the episode, identified by their ISO 639-1 code.

String name

The name of the episode.

String releaseDate

The date the episode was first released, for example "1981-12-15". Depending on the precision, it might be shown as "1981" or "1981-12".

ReleaseDatePrecision releaseDatePrecision

The precision with which release_date value is known.

Accepts one of the following:

YEAR("year")

MONTH("month")

DAY("day")

ShowBase show

The show on which the episode belongs.

String id

The Spotify ID for the show.

List<String> availableMarkets

A list of the countries in which the show can be played, identified by their ISO 3166-1 alpha-2 code.

List<CopyrightObject> copyrights

The copyright statements of the show.

Optional<Boolean> published

Optional<String> text

The copyright text for this content.

Optional<String> type

The type of copyright: C = the copyright, P = the sound recording (performance) copyright.

String description

A description of the show. HTML tags are stripped away from this field, use html_description field in case HTML tags are needed.

boolean explicit

Whether or not the show has explicit content (true = yes it does; false = no it does not OR unknown).

ExternalUrlObject externalUrls

External URLs for this show.

Optional<Boolean> published

Optional<String> spotify

The Spotify URL for the object.

String href

A link to the Web API endpoint providing full details of the show.

String htmlDescription

A description of the show. This field may contain HTML tags.

List<ImageObject> images

The cover art for the show in various sizes, widest first.

Optional<Long> height

The image height in pixels.

String url

The source URL of the image.

Optional<Long> width

The image width in pixels.

Optional<Boolean> published

boolean isExternallyHosted

True if all of the shows episodes are hosted outside of Spotify's CDN. This field might be null in some cases.

List<String> languages

A list of the languages used in the show, identified by their ISO 639 code.

String mediaType

The media type of the show.

String name

The name of the episode.

String publisher

The publisher of the show.

long totalEpisodes

The total number of episodes in the show.

JsonValue; type

The object type.

String uri

The Spotify URI for the show.

Optional<Boolean> published

JsonValue; type

The object type.

String uri

The Spotify URI for the episode.

DeprecatedOptional<String> language

The language used in the episode, identified by a ISO 639 code. This field is deprecated and might be removed in the future. Please use the languages field instead.

Optional<Boolean> published

Optional<EpisodeRestrictionObject> restrictions

Included in the response when a content restriction is applied.

Optional<Boolean> published

Optional<String> reason

The reason for the restriction. Supported values:

market - The content item is not available in the given market.
product - The content item is not available for the user's subscription type.
explicit - The content item is explicit and the user's account is set to not play explicit content.

Additional reasons may be added in the future. Note: If you use this field, make sure that your application safely handles unknown values.

Optional<ResumePointObject> resumePoint

The user's most recent position in the episode. Set if the supplied access token is a user token and has the scope 'user-read-playback-position'.

Optional<Boolean> fullyPlayed

Whether or not the episode has been fully played by the user.

Optional<Boolean> published

Optional<Long> resumePositionMs

The user's most recent position in the episode in milliseconds.

Optional<Boolean> published

Optional<String> type

The object type: "playlist"

Optional<String> uri

The Spotify URI for the playlist.

Get Playlist

package dev.cjav.spotted.example;

import dev.cjav.spotted.client.SpottedClient;
import dev.cjav.spotted.client.okhttp.SpottedOkHttpClient;
import dev.cjav.spotted.models.playlists.PlaylistRetrieveParams;
import dev.cjav.spotted.models.playlists.PlaylistRetrieveResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        SpottedClient client = SpottedOkHttpClient.fromEnv();

        PlaylistRetrieveResponse playlist = client.playlists().retrieve("3cEYpjA9oz9GiPac4AsH4n");
    }
}

{
  "id": "id",
  "collaborative": true,
  "description": "description",
  "external_urls": {
    "published": true,
    "spotify": "spotify"
  },
  "followers": {
    "href": "href",
    "published": true,
    "total": 0
  },
  "href": "href",
  "images": [
    {
      "height": 300,
      "url": "https://i.scdn.co/image/ab67616d00001e02ff9ca10b55ce82ae553c8228\n",
      "width": 300,
      "published": true
    }
  ],
  "name": "name",
  "owner": {
    "id": "id",
    "external_urls": {
      "published": true,
      "spotify": "spotify"
    },
    "href": "href",
    "published": true,
    "type": "user",
    "uri": "uri",
    "display_name": "display_name"
  },
  "published": true,
  "snapshot_id": "snapshot_id",
  "tracks": {
    "href": "https://api.spotify.com/v1/me/shows?offset=0&limit=20\n",
    "limit": 20,
    "next": "https://api.spotify.com/v1/me/shows?offset=1&limit=1",
    "offset": 0,
    "previous": "https://api.spotify.com/v1/me/shows?offset=1&limit=1",
    "total": 4,
    "items": [
      {
        "added_at": "2019-12-27T18:11:19.117Z",
        "added_by": {
          "id": "id",
          "external_urls": {
            "published": true,
            "spotify": "spotify"
          },
          "href": "href",
          "published": true,
          "type": "user",
          "uri": "uri"
        },
        "is_local": true,
        "published": true,
        "track": {
          "id": "id",
          "album": {
            "id": "2up3OPMp9Tb4dAKM2erWXQ",
            "album_type": "compilation",
            "artists": [
              {
                "id": "id",
                "external_urls": {
                  "published": true,
                  "spotify": "spotify"
                },
                "href": "href",
                "name": "name",
                "published": true,
                "type": "artist",
                "uri": "uri"
              }
            ],
            "available_markets": [
              "CA",
              "BR",
              "IT"
            ],
            "external_urls": {
              "published": true,
              "spotify": "spotify"
            },
            "href": "href",
            "images": [
              {
                "height": 300,
                "url": "https://i.scdn.co/image/ab67616d00001e02ff9ca10b55ce82ae553c8228\n",
                "width": 300,
                "published": true
              }
            ],
            "name": "name",
            "release_date": "1981-12",
            "release_date_precision": "year",
            "total_tracks": 9,
            "type": "album",
            "uri": "spotify:album:2up3OPMp9Tb4dAKM2erWXQ",
            "published": true,
            "restrictions": {
              "published": true,
              "reason": "market"
            }
          },
          "artists": [
            {
              "id": "id",
              "external_urls": {
                "published": true,
                "spotify": "spotify"
              },
              "href": "href",
              "name": "name",
              "published": true,
              "type": "artist",
              "uri": "uri"
            }
          ],
          "available_markets": [
            "string"
          ],
          "disc_number": 0,
          "duration_ms": 0,
          "explicit": true,
          "external_ids": {
            "ean": "ean",
            "isrc": "isrc",
            "published": true,
            "upc": "upc"
          },
          "external_urls": {
            "published": true,
            "spotify": "spotify"
          },
          "href": "href",
          "is_local": true,
          "is_playable": true,
          "linked_from": {
            "id": "id",
            "external_urls": {
              "published": true,
              "spotify": "spotify"
            },
            "href": "href",
            "published": true,
            "type": "type",
            "uri": "uri"
          },
          "name": "name",
          "popularity": 0,
          "preview_url": "preview_url",
          "published": true,
          "restrictions": {
            "published": true,
            "reason": "reason"
          },
          "track_number": 0,
          "type": "track",
          "uri": "uri"
        }
      }
    ],
    "published": true
  },
  "type": "type",
  "uri": "uri"
}

Returns Examples

{
  "id": "id",
  "collaborative": true,
  "description": "description",
  "external_urls": {
    "published": true,
    "spotify": "spotify"
  },
  "followers": {
    "href": "href",
    "published": true,
    "total": 0
  },
  "href": "href",
  "images": [
    {
      "height": 300,
      "url": "https://i.scdn.co/image/ab67616d00001e02ff9ca10b55ce82ae553c8228\n",
      "width": 300,
      "published": true
    }
  ],
  "name": "name",
  "owner": {
    "id": "id",
    "external_urls": {
      "published": true,
      "spotify": "spotify"
    },
    "href": "href",
    "published": true,
    "type": "user",
    "uri": "uri",
    "display_name": "display_name"
  },
  "published": true,
  "snapshot_id": "snapshot_id",
  "tracks": {
    "href": "https://api.spotify.com/v1/me/shows?offset=0&limit=20\n",
    "limit": 20,
    "next": "https://api.spotify.com/v1/me/shows?offset=1&limit=1",
    "offset": 0,
    "previous": "https://api.spotify.com/v1/me/shows?offset=1&limit=1",
    "total": 4,
    "items": [
      {
        "added_at": "2019-12-27T18:11:19.117Z",
        "added_by": {
          "id": "id",
          "external_urls": {
            "published": true,
            "spotify": "spotify"
          },
          "href": "href",
          "published": true,
          "type": "user",
          "uri": "uri"
        },
        "is_local": true,
        "published": true,
        "track": {
          "id": "id",
          "album": {
            "id": "2up3OPMp9Tb4dAKM2erWXQ",
            "album_type": "compilation",
            "artists": [
              {
                "id": "id",
                "external_urls": {
                  "published": true,
                  "spotify": "spotify"
                },
                "href": "href",
                "name": "name",
                "published": true,
                "type": "artist",
                "uri": "uri"
              }
            ],
            "available_markets": [
              "CA",
              "BR",
              "IT"
            ],
            "external_urls": {
              "published": true,
              "spotify": "spotify"
            },
            "href": "href",
            "images": [
              {
                "height": 300,
                "url": "https://i.scdn.co/image/ab67616d00001e02ff9ca10b55ce82ae553c8228\n",
                "width": 300,
                "published": true
              }
            ],
            "name": "name",
            "release_date": "1981-12",
            "release_date_precision": "year",
            "total_tracks": 9,
            "type": "album",
            "uri": "spotify:album:2up3OPMp9Tb4dAKM2erWXQ",
            "published": true,
            "restrictions": {
              "published": true,
              "reason": "market"
            }
          },
          "artists": [
            {
              "id": "id",
              "external_urls": {
                "published": true,
                "spotify": "spotify"
              },
              "href": "href",
              "name": "name",
              "published": true,
              "type": "artist",
              "uri": "uri"
            }
          ],
          "available_markets": [
            "string"
          ],
          "disc_number": 0,
          "duration_ms": 0,
          "explicit": true,
          "external_ids": {
            "ean": "ean",
            "isrc": "isrc",
            "published": true,
            "upc": "upc"
          },
          "external_urls": {
            "published": true,
            "spotify": "spotify"
          },
          "href": "href",
          "is_local": true,
          "is_playable": true,
          "linked_from": {
            "id": "id",
            "external_urls": {
              "published": true,
              "spotify": "spotify"
            },
            "href": "href",
            "published": true,
            "type": "type",
            "uri": "uri"
          },
          "name": "name",
          "popularity": 0,
          "preview_url": "preview_url",
          "published": true,
          "restrictions": {
            "published": true,
            "reason": "reason"
          },
          "track_number": 0,
          "type": "track",
          "uri": "uri"
        }
      }
    ],
    "published": true
  },
  "type": "type",
  "uri": "uri"
}