Get Show

ShowRetrieveResponse shows().retrieve(, )

GET/shows/{id}

Get Spotify catalog information for a single show identified by its unique Spotify ID.

ParametersExpand Collapse

ShowRetrieveParams params

Optional<String> id

The Spotify ID for the show.

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 ShowRetrieveResponse:

Episodes episodes

The episodes of the show.

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<SimplifiedEpisodeObject>> items

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

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.

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

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

Get Show

package dev.cjav.spotted.example;

import dev.cjav.spotted.client.SpottedClient;
import dev.cjav.spotted.client.okhttp.SpottedOkHttpClient;
import dev.cjav.spotted.models.shows.ShowRetrieveParams;
import dev.cjav.spotted.models.shows.ShowRetrieveResponse;

public final class Main {
    private Main() {}

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

        ShowRetrieveResponse show = client.shows().retrieve("38bS44xjbVVZ3No3ByF1dJ");
    }
}

{
  "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,
  "episodes": {
    "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": [
      {
        "id": "5Xt5DXGzch68nYYamXrNxZ",
        "audio_preview_url": "https://p.scdn.co/mp3-preview/2f37da1d4221f40b9d1a98cd191f4d6f1646ad17",
        "description": "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.\n",
        "duration_ms": 1686230,
        "explicit": true,
        "external_urls": {
          "published": true,
          "spotify": "spotify"
        },
        "href": "https://api.spotify.com/v1/episodes/5Xt5DXGzch68nYYamXrNxZ",
        "html_description": "<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>\n",
        "images": [
          {
            "height": 300,
            "url": "https://i.scdn.co/image/ab67616d00001e02ff9ca10b55ce82ae553c8228\n",
            "width": 300,
            "published": true
          }
        ],
        "is_externally_hosted": true,
        "is_playable": true,
        "languages": [
          "fr",
          "en"
        ],
        "name": "Starting Your Own Podcast: Tips, Tricks, and Advice From Anchor Creators\n",
        "release_date": "1981-12-15",
        "release_date_precision": "day",
        "type": "episode",
        "uri": "spotify:episode:0zLhl3WsOCQHbe1BPTiHgr",
        "language": "en",
        "published": true,
        "restrictions": {
          "published": true,
          "reason": "reason"
        },
        "resume_point": {
          "fully_played": true,
          "published": true,
          "resume_position_ms": 0
        }
      }
    ],
    "published": true
  }
}

Returns Examples

{
  "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,
  "episodes": {
    "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": [
      {
        "id": "5Xt5DXGzch68nYYamXrNxZ",
        "audio_preview_url": "https://p.scdn.co/mp3-preview/2f37da1d4221f40b9d1a98cd191f4d6f1646ad17",
        "description": "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.\n",
        "duration_ms": 1686230,
        "explicit": true,
        "external_urls": {
          "published": true,
          "spotify": "spotify"
        },
        "href": "https://api.spotify.com/v1/episodes/5Xt5DXGzch68nYYamXrNxZ",
        "html_description": "<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>\n",
        "images": [
          {
            "height": 300,
            "url": "https://i.scdn.co/image/ab67616d00001e02ff9ca10b55ce82ae553c8228\n",
            "width": 300,
            "published": true
          }
        ],
        "is_externally_hosted": true,
        "is_playable": true,
        "languages": [
          "fr",
          "en"
        ],
        "name": "Starting Your Own Podcast: Tips, Tricks, and Advice From Anchor Creators\n",
        "release_date": "1981-12-15",
        "release_date_precision": "day",
        "type": "episode",
        "uri": "spotify:episode:0zLhl3WsOCQHbe1BPTiHgr",
        "language": "en",
        "published": true,
        "restrictions": {
          "published": true,
          "reason": "reason"
        },
        "resume_point": {
          "fully_played": true,
          "published": true,
          "resume_position_ms": 0
        }
      }
    ],
    "published": true
  }
}