Get User's Saved Episodes

EpisodeListPageResponse Me.Episodes.List(, )

GET/me/episodes

Get a list of the episodes saved in the current Spotify user's library.
This API endpoint is in beta and could change without warning. Please share any feedback that you have, or issues that you discover, in our developer community forum.

ParametersExpand Collapse

EpisodeListParams parameters

Long limit

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

minimum1

maximum50

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.

Long offset

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

required string Href

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

required Long Limit

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

required string? Next

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

required Long Offset

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

required string? Previous

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

required Long Total

The total number of items available to return.

IReadOnlyList<EpisodeListResponse> Items

DateTimeOffset AddedAt

The date and time the episode was saved. Timestamps are returned in ISO 8601 format as Coordinated Universal Time (UTC) with a zero offset: YYYY-MM-DDTHH:MM:SSZ.

formatdate-time

EpisodeObject Episode

Information about the episode.

required string ID

The Spotify ID for the episode.

Deprecatedrequired string? AudioPreviewUrl

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

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

required Long DurationMs

The episode length in milliseconds.

required Boolean Explicit

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

required ExternalUrlObject ExternalUrls

External URLs for this episode.

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

string Spotify

The Spotify URL for the object.

required string Href

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

required string HtmlDescription

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

required IReadOnlyList<ImageObject> Images

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

required Long? Height

The image height in pixels.

required string Url

The source URL of the image.

required Long? Width

The image width in pixels.

Boolean Published

required Boolean IsExternallyHosted

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

required Boolean IsPlayable

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

required IReadOnlyList<string> Languages

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

required string Name

The name of the episode.

required 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".

required ReleaseDatePrecision ReleaseDatePrecision

The precision with which release_date value is known.

Accepts one of the following:

required ShowBase Show

The show on which the episode belongs.

required string ID

The Spotify ID for the show.

required IReadOnlyList<string> AvailableMarkets

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

required IReadOnlyList<CopyrightObject> Copyrights

The copyright statements of the show.

Boolean Published

string Text

The copyright text for this content.

string Type

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

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

required Boolean Explicit

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

required ExternalUrlObject ExternalUrls

External URLs for this show.

Boolean Published

string Spotify

The Spotify URL for the object.

required string Href

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

required string HtmlDescription

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

required IReadOnlyList<ImageObject> Images

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

required Long? Height

The image height in pixels.

required string Url

The source URL of the image.

required Long? Width

The image width in pixels.

Boolean Published

required Boolean IsExternallyHosted

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

required IReadOnlyList<string> Languages

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

required string MediaType

The media type of the show.

required string Name

The name of the episode.

required string Publisher

The publisher of the show.

required Long TotalEpisodes

The total number of episodes in the show.

JsonElement Type

The object type.

required string Uri

The Spotify URI for the show.

Boolean Published

JsonElement Type

The object type.

required string Uri

The Spotify URI for the episode.

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

Boolean Published

EpisodeRestrictionObject Restrictions

Included in the response when a content restriction is applied.

Boolean Published

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.

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

Boolean FullyPlayed

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

Boolean Published

Long ResumePositionMs

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

Boolean Published

Get User's Saved Episodes

EpisodeListParams parameters = new();

var page = await client.Me.Episodes.List(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}

{
  "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",
      "episode": {
        "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",
        "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
        },
        "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
    }
  ],
  "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",
      "episode": {
        "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",
        "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
        },
        "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
    }
  ],
  "published": true
}