Spotify Web API

v0.4.0

Spotify Web API v0.4.0 Spotify.Playlists View Source

For manipulating playlists.

Spotify Docs

Link to this section Summary

Types

added_at()

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

added_by()

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

collaborative()

true if the owner allows other users to modify the playlist

description()

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

external_urls()

Known external URLs for this playlist

followers()

Information about the followers of the playlist

href()

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

id()

The Spotify ID for the playlist

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

is_local()

Whether this track is a local file or not

name()

The name of the playlist

owner()

The user who owns the playlist

public()

The playlist’s public/private status: true the playlist is public, false the playlist is private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists

snapshot_id()

The version identifier for the current playlist. Can be supplied in other requests to target a specific playlist version: see Remove tracks from a playlist

track()

Information about the track

tracks()

Information about the tracks of the playlist

type()

The object type: playlist

uri()

The Spotify URI for the playlist

Link to this section Types

Link to this type added_at() View Source 
added_at() :: Spotify.Timestamp.t() | nil

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

Link to this type added_by() View Source 
added_by() :: Spotify.Users.UserPublic.t() | nil

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

Link to this type collaborative() View Source 
collaborative() :: boolean()

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

Link to this type description() View Source 
description() :: String.t() | nil

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

Link to this type external_urls() View Source 
external_urls() :: Spotify.ExternalUrls.t()

Known external URLs for this playlist.

Link to this type followers() View Source 
followers() :: Spotify.Followers.t()

Information about the followers of the playlist.

Link to this type href() View Source 
href() :: String.t()

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

Link to this type id() View Source 
id() :: String.t()

The Spotify ID for the playlist.

Link to this type images() View Source 
images() :: [Spotify.Image.t()] | []

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.

Link to this type is_local() View Source 
is_local() :: boolean()

Whether this track is a local file or not.

Link to this type name() View Source 
name() :: String.t()

The name of the playlist.

Link to this type owner() View Source 
owner() :: Spotify.Users.UserPublic.t()

The user who owns the playlist

Link to this type public() View Source 
public() :: boolean() | nil

The playlist’s public/private status: true the playlist is public, false the playlist is private, null the playlist status is not relevant. For more about public/private status, see Working with Playlists.

Link to this type snapshot_id() View Source 
snapshot_id() :: String.t()

The version identifier for the current playlist. Can be supplied in other requests to target a specific playlist version: see Remove tracks from a playlist

Link to this type track() View Source 
track() :: Spotify.Tracks.TrackFull.t()

Information about the track.

Link to this type tracks() View Source 
tracks() :: Spotify.Pagings.Paging.t(Spotify.Playlists.PlaylistTrack.t())

Information about the tracks of the playlist.

Link to this type type() View Source 
type() :: String.t()

The object type: playlist

Link to this type uri() View Source 
uri() :: String.t()

The Spotify URI for the playlist.