Skip to main content
Server path: /spotify-library | Type: Application | PCID required: Yes

Tools


spotify_library_check_library_contains

Check User’s Saved Items Parameters:
ParameterTypeRequiredDefaultDescription
urisstringYesA comma-separated list of Spotify URIs. Maximum: 40 URIs. Supported URI types: - spotify:track:{id} - spotify:album:{id} - spotify:episode:{id} - spotify:show:{id} - spotify:audiobook:{id} - spotify:artist:{id} - spotify:user:{id} - spotify:playlist:{id}

spotify_library_create_playlist

Create Playlist Parameters:
ParameterTypeRequiredDefaultDescription
collaborativebooleanNoDefaults to false. If true the playlist will be collaborative. Note: to create a collaborative playlist you must also set public to false. To create collaborative playlists you must have granted playlist-modify-private and playlist-modify-public scopes.
descriptionstringNovalue for playlist description as displayed in Spotify Clients and in the Web API.
namestringYesThe name for the new playlist, for example "Your Coolest Playlist". This name does not need to be unique; a user may have several playlists with the same name.
publicbooleanNoDefaults to true. 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. To be able to create private playlists, the user must have granted the playlist-modify-private scope. For more about public/private status, see Working with Playlists

spotify_library_get_a_list_of_current_users_playlists

Get Current User’s Playlists Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoThe maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.
offsetintegerNo‘The index of the first playlist to return. Default: 0 (the first object). Maximum offset: 100.000. Use with limit to get the next set of playlists.‘

spotify_library_get_current_users_profile

Get Current User’s Profile

spotify_library_get_followed

Get Followed Artists Parameters:
ParameterTypeRequiredDefaultDescription
typestringYesThe ID type: currently only artist is supported.
afterstringNoThe last artist ID retrieved from the previous request.
limitintegerNoThe maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.

spotify_library_get_users_saved_albums

Get User’s Saved Albums Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoThe maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.
offsetintegerNoThe index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items.
marketstringNoAn ISO 3166-1 alpha-2 country code. If a country code is specified, only content that is available in that market will be returned.<br/> 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.<br/> Note: If neither market or user country are provided, the content is considered unavailable for the client.<br/> Users can view the country that is associated with their account in the account settings.

spotify_library_get_users_saved_audiobooks

Get User’s Saved Audiobooks Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoThe maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.
offsetintegerNoThe index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items.

spotify_library_get_users_saved_episodes

Get User’s Saved Episodes Parameters:
ParameterTypeRequiredDefaultDescription
marketstringNoAn ISO 3166-1 alpha-2 country code. If a country code is specified, only content that is available in that market will be returned.<br/> 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.<br/> Note: If neither market or user country are provided, the content is considered unavailable for the client.<br/> Users can view the country that is associated with their account in the account settings.
limitintegerNoThe maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.
offsetintegerNoThe index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items.

spotify_library_get_users_saved_shows

Get User’s Saved Shows Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoThe maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.
offsetintegerNoThe index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items.

spotify_library_get_users_saved_tracks

Get User’s Saved Tracks Parameters:
ParameterTypeRequiredDefaultDescription
marketstringNoAn ISO 3166-1 alpha-2 country code. If a country code is specified, only content that is available in that market will be returned.<br/> 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.<br/> Note: If neither market or user country are provided, the content is considered unavailable for the client.<br/> Users can view the country that is associated with their account in the account settings.
limitintegerNoThe maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.
offsetintegerNoThe index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items.

spotify_library_get_users_top_artists_and_tracks

Get User’s Top Items Parameters:
ParameterTypeRequiredDefaultDescription
typestringYesThe type of entity to return. Valid values: artists or tracks
time_rangestringNoOver what time frame the affinities are computed. Valid values: long_term (calculated from ~1 year of data and including all new data as it becomes available), medium_term (approximately last 6 months), short_term (approximately last 4 weeks). Default: medium_term
limitintegerNoThe maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50.
offsetintegerNoThe index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items.

spotify_library_remove_library_items

Remove Items from Library Parameters:
ParameterTypeRequiredDefaultDescription
urisstringYesA comma-separated list of Spotify URIs. Maximum: 40 URIs. Supported URI types: - spotify:track:&#123;id&#125; - spotify:album:&#123;id&#125; - spotify:episode:&#123;id&#125; - spotify:show:&#123;id&#125; - spotify:audiobook:&#123;id&#125; - spotify:user:&#123;id&#125; - spotify:playlist:&#123;id&#125;

spotify_library_save_library_items

Save Items to Library Parameters:
ParameterTypeRequiredDefaultDescription
urisstringYesA comma-separated list of Spotify URIs. Maximum: 40 URIs. Supported URI types: - spotify:track:&#123;id&#125; - spotify:album:&#123;id&#125; - spotify:episode:&#123;id&#125; - spotify:show:&#123;id&#125; - spotify:audiobook:&#123;id&#125; - spotify:user:&#123;id&#125; - spotify:playlist:&#123;id&#125;