Get User's Saved Shows

me().shows().list(, ) : ShowListPage

GET/me/shows

Get a list of shows saved in the current Spotify user's library. Optional parameters can be used to limit the number of shows returned.

ParametersExpand Collapse

params: ShowListParams

limit: Optional<Long>

The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.

minimum1

maximum50

offset: Optional<Long>

The index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items.

ReturnsExpand Collapse

class ShowListResponse:

addedAt: Optional<LocalDateTime>

The date and time the show was saved. Timestamps are returned in ISO 8601 format as Coordinated Universal Time (UTC) with a zero offset: YYYY-MM-DDTHH:MM:SSZ. If the time is imprecise (for example, the date/time of an album release), an additional field indicates the precision; see for example, release_date in an album object.

formatdate-time

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

show: Optional<ShowBase>

Information about the show.

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.

copyrights: List<CopyrightObject>

The copyright statements of the show.

published: Optional<Boolean>

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).

externalUrls: ExternalUrlObject

External URLs for this show.

published: Optional<Boolean>

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.

images: List<ImageObject>

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>

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;

The object type.

uri: String

The Spotify URI for the show.

published: Optional<Boolean>

Get User's Saved Shows

package dev.cjav.spotted.example

import dev.cjav.spotted.client.SpottedClient
import dev.cjav.spotted.client.okhttp.SpottedOkHttpClient
import dev.cjav.spotted.models.me.shows.ShowListPage
import dev.cjav.spotted.models.me.shows.ShowListParams

fun main() {
    val client: SpottedClient = SpottedOkHttpClient.fromEnv()

    val page: ShowListPage = client.me().shows().list()
}

{
  "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",
      "published": true,
      "show": {
        "id": "id",
        "available_markets": [
          "string"
        ],
        "copyrights": [
          {
            "published": true,
            "text": "text",
            "type": "type"
          }
        ],
        "description": "description",
        "explicit": true,
        "external_urls": {
          "published": true,
          "spotify": "spotify"
        },
        "href": "href",
        "html_description": "html_description",
        "images": [
          {
            "height": 300,
            "url": "https://i.scdn.co/image/ab67616d00001e02ff9ca10b55ce82ae553c8228\n",
            "width": 300,
            "published": true
          }
        ],
        "is_externally_hosted": true,
        "languages": [
          "string"
        ],
        "media_type": "media_type",
        "name": "name",
        "publisher": "publisher",
        "total_episodes": 0,
        "type": "show",
        "uri": "uri",
        "published": true
      }
    }
  ],
  "published": true
}

Returns Examples

{
  "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",
      "published": true,
      "show": {
        "id": "id",
        "available_markets": [
          "string"
        ],
        "copyrights": [
          {
            "published": true,
            "text": "text",
            "type": "type"
          }
        ],
        "description": "description",
        "explicit": true,
        "external_urls": {
          "published": true,
          "spotify": "spotify"
        },
        "href": "href",
        "html_description": "html_description",
        "images": [
          {
            "height": 300,
            "url": "https://i.scdn.co/image/ab67616d00001e02ff9ca10b55ce82ae553c8228\n",
            "width": 300,
            "published": true
          }
        ],
        "is_externally_hosted": true,
        "languages": [
          "string"
        ],
        "media_type": "media_type",
        "name": "name",
        "publisher": "publisher",
        "total_episodes": 0,
        "type": "show",
        "uri": "uri",
        "published": true
      }
    }
  ],
  "published": true
}