/spotify-library | Type: Application | PCID required: Yes
Tools
| Tool | Description |
|---|---|
spotify_library_check_library_contains | Check User’s Saved Items |
spotify_library_create_playlist | Create Playlist |
spotify_library_get_a_list_of_current_users_playlists | Get Current User’s Playlists |
spotify_library_get_current_users_profile | Get Current User’s Profile |
spotify_library_get_followed | Get Followed Artists |
spotify_library_get_users_saved_albums | Get User’s Saved Albums |
spotify_library_get_users_saved_audiobooks | Get User’s Saved Audiobooks |
spotify_library_get_users_saved_episodes | Get User’s Saved Episodes |
spotify_library_get_users_saved_shows | Get User’s Saved Shows |
spotify_library_get_users_saved_tracks | Get User’s Saved Tracks |
spotify_library_get_users_top_artists_and_tracks | Get User’s Top Items |
spotify_library_remove_library_items | Remove Items from Library |
spotify_library_save_library_items | Save Items to Library |
spotify_library_check_library_contains
Check User’s Saved Items Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
uris | string | Yes | — | A 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
collaborative | boolean | No | — | Defaults 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. |
description | string | No | — | value for playlist description as displayed in Spotify Clients and in the Web API. |
name | string | Yes | — | The 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. |
public | boolean | No | — | Defaults 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. |
offset | integer | No | — | ‘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 Profilespotify_library_get_followed
Get Followed Artists Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
type | string | Yes | — | The ID type: currently only artist is supported. |
after | string | No | — | The last artist ID retrieved from the previous request. |
limit | integer | No | — | The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. |
spotify_library_get_users_saved_albums
Get User’s Saved Albums Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. |
offset | integer | No | — | The index of the first item to return. Default: 0 (the first item). Use with limit to get the next set of items. |
market | string | No | — | 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.<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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. |
offset | integer | No | — | The 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
market | string | No | — | 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.<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. |
limit | integer | No | — | The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. |
offset | integer | No | — | The 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. |
offset | integer | No | — | The 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
market | string | No | — | 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.<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. |
limit | integer | No | — | The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. |
offset | integer | No | — | The 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
type | string | Yes | — | The type of entity to return. Valid values: artists or tracks |
time_range | string | No | — | Over 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 |
limit | integer | No | — | The maximum number of items to return. Default: 20. Minimum: 1. Maximum: 50. |
offset | integer | No | — | The 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:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
uris | string | Yes | — | A 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:user:{id} - spotify:playlist:{id} |
spotify_library_save_library_items
Save Items to Library Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
uris | string | Yes | — | A 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:user:{id} - spotify:playlist:{id} |

