> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Spotify

> How to set up the Spotify connector, plus the actions that are available.

![Spotify](https://stackone-logos.com/api/spotify/filled/svg)

Previewv1.1.2[See changelog](https://docs.stackone.com/connectors/spotify/changelog.md)

[47 actions](#actions) · 1 auth method

Media

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/spotify/guides/connector-profile/oauth-2-0.md)
>
> OAuth 2.0 provides secure access to Spotify Web API. Create a Spotify App in the Developer Dashboard to get started.

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/spotify/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

playlist-modify-private

playlist-modify-public

playlist-read-private

user-follow-modify

user-follow-read

user-library-modify

user-library-read

user-modify-playback-state

user-read-currently-playing

user-read-email

user-read-playback-position

user-read-playback-state

user-read-private

user-read-recently-played

user-top-read

No scopes found

47 actions

ActionDescriptionRequired scopes

Get Album`spotify_get_album`

Get Spotify catalog information for a single album

Get Album Tracks`spotify_get_album_tracks`

Get Spotify catalog information about an album's tracks

Get User's Saved Albums`spotify_get_users_saved_albums`

Get a list of the albums saved in the current Spotify user's 'Your Music' library

`user-library-read`

Get Artist`spotify_get_artist`

Get Spotify catalog information for a single artist

Get Artist's Albums`spotify_get_artist_albums`

Get Spotify catalog information about an artist's albums

Get Audiobook`spotify_get_audiobook`

Get Spotify catalog information for a single audiobook

Get Audiobook Chapters`spotify_get_audiobook_chapters`

Get Spotify catalog information about an audiobook's chapters

Get Chapter`spotify_get_chapter`

Get Spotify catalog information for a single chapter

Get User's Saved Audiobooks`spotify_get_users_saved_audiobooks`

Get a list of the audiobooks saved in the current Spotify user's library

`user-library-read`

Get Episode`spotify_get_episode`

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

`user-read-playback-position`

Get User's Saved Episodes`spotify_get_saved_episodes`

Get a list of the episodes saved in the current Spotify user's library

`user-library-read``user-read-playback-position`

Get Playback State`spotify_get_playback_state`

Get information about the user's current playback state, including track or episode, progress, and active device

`user-read-playback-state`

Transfer Playback`spotify_transfer_playback`

Transfer playback to a new device and optionally begin playback

`user-modify-playback-state`

Get Available Devices`spotify_get_available_devices`

Get information about a user's available Spotify Connect devices

`user-read-playback-state`

Get Currently Playing Track`spotify_get_currently_playing`

Get the object currently being played on the user's Spotify account

`user-read-currently-playing`

Start/Resume Playback`spotify_start_playback`

Start a new context or resume current playback on the user's active device

`user-modify-playback-state`

Pause Playback`spotify_pause_playback`

Pause playback on the user's account

`user-modify-playback-state`

Skip To Next Track`spotify_skip_to_next`

Skips to next track in the user's queue

`user-modify-playback-state`

Skip To Previous Track`spotify_skip_to_previous`

Skips to previous track in the user's queue

`user-modify-playback-state`

Seek To Position`spotify_seek_to_position`

Seeks to the given position in the user's currently playing track

`user-modify-playback-state`

Set Repeat Mode`spotify_set_repeat_mode`

Set the repeat mode for the user's playback

`user-modify-playback-state`

Set Playback Volume`spotify_set_volume`

Set the volume for the user's current playback device

`user-modify-playback-state`

Toggle Playback Shuffle`spotify_toggle_shuffle`

Toggle shuffle on or off for user's playback

`user-modify-playback-state`

Get Recently Played Tracks`spotify_get_recently_played`

Get tracks from the current user's recently played tracks

`user-read-recently-played`

Get The User's Queue`spotify_get_queue`

Get the list of objects that make up the user's queue

`user-read-currently-playing``user-read-playback-state`

Add Item To Playback Queue`spotify_add_to_queue`

Add an item to the end of the user's current playback queue

`user-modify-playback-state`

Get Playlist`spotify_get_playlist`

Get a playlist owned by a Spotify user

Get Playlist Items`spotify_get_playlist_items`

Get full details of the items of a playlist owned by a Spotify user

`playlist-read-private`

Get Current User's Playlists`spotify_get_current_users_playlists`

Get a list of the playlists owned or followed by the current Spotify user

`playlist-read-private`

Create Playlist`spotify_create_playlist`

Create a playlist for a Spotify user

`playlist-modify-public``playlist-modify-private`

Change Playlist Details`spotify_change_playlist_details`

Change a playlist's name and public/private state

`playlist-modify-public``playlist-modify-private`

Add Items To Playlist`spotify_add_items_to_playlist`

Add one or more items to a user's playlist

`playlist-modify-public``playlist-modify-private`

Reorder Or Replace Playlist Items`spotify_reorder_or_replace_playlist_items`

Either reorder or replace items in a playlist depending on the request's parameters. The body must use exactly one of tw\...

`playlist-modify-public``playlist-modify-private`

Remove Playlist Items`spotify_remove_playlist_items`

Remove one or more items from a user's playlist

`playlist-modify-public``playlist-modify-private`

Get Playlist Cover Image`spotify_get_playlist_cover_image`

Get the current image associated with a specific playlist

Search For Item`spotify_search`

Get Spotify catalog information about albums, artists, playlists, tracks, shows, episodes or audiobooks that match a key...

Get Track`spotify_get_track`

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

Get User's Saved Tracks`spotify_get_saved_tracks`

Get a list of the songs saved in the current user's library

`user-library-read`

Get User's Saved Shows`spotify_get_saved_shows`

Get a list of shows saved in the current Spotify user's library

`user-library-read`

Get Show Episodes`spotify_get_show_episodes`

Get Spotify catalog information about a show's episodes

`user-read-playback-position`

Get Show`spotify_get_show`

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

`user-read-playback-position`

Get Current User Profile`spotify_get_current_user_profile`

Get detailed profile information about the current user

`user-read-private``user-read-email`

Check User's Saved Items`spotify_check_saved_items`

Check if one or more items are already saved in the current user's library

`user-library-read``user-follow-read``playlist-read-private`

Save Library Items`spotify_save_library_items`

Save one or more items to the current user's library

`user-library-modify``user-follow-modify``playlist-modify-public`

Remove Items From Library`spotify_remove_library_items`

Remove one or more items from the current user's library

`user-library-modify``user-follow-modify``playlist-modify-public`

Get User's Top Artists And Tracks`spotify_get_users_top_items`

Get the current user's top artists or tracks based on calculated affinity

`user-top-read`

Get Followed Artists`spotify_get_followed_artists`

Get the current user's followed artists

`user-follow-read`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.