NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Spotify

spotify

Spotify is a digital music and podcast streaming service with millions of tracks, personalized playlists, and social sharing features

News & LifestyleWeb del proveedor
Acciones
109
Triggers
3
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (109)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Add items to playlistSPOTIFY_ADD_ITEMS_TO_PLAYLISTAcción

Add one or more items to a user's playlist.

Parámetros de entrada

  • urisstring[]

    A JSON array of the [Spotify URIs](/documentation/web-api/concepts/spotify-uris-ids) to add. For example: `{"uris": ["spotify:track:4iV5W9uYEdYUVa79Axb7Rh","spotify:track:1301WleyT98MSxVHPZCA6M", "spotify:episode:512ojhOuo1ktJprKbVcKyQ"]}`<br/>A maximum of 100 items can be added in one request. _**Note**: if the `uris` parameter is present in the query string, any URIs listed here in the body will be ignored._

  • positioninteger

    The position to insert the items, a zero-based index. For example, to insert the items in the first position: `position=0` ; to insert the items in the third position: `position=2`. If omitted, the items will be appended to the playlist. Items are added in the order they appear in the uris array. For example: `{"uris": ["spotify:track:4iV5W9uYEdYUVa79Axb7Rh","spotify:track:1301WleyT98MSxVHPZCA6M"], "position": 3}`

  • playlist_idstringObligatorio

    Playlist Id

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add item to playback queueSPOTIFY_ADD_ITEM_TO_PLAYBACK_QUEUEAcción

Add an item to the end of the user's current playback queue. this api only works for users who have spotify premium. the order of execution is not guaranteed when you use this api with other player api endpoints.

Parámetros de entrada

  • uristringObligatorio

    Uri

  • device_idstring

    Device Id

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add items to playlistSPOTIFY_ADD_TRACKS_TO_PLAYLISTAcción

Add one or more items to a user's playlist. <<DEPRECATED use add_items_to_playlist>>

Parámetros de entrada

  • urisstring[]

    A JSON array of the [Spotify URIs](/documentation/web-api/concepts/spotify-uris-ids) to add. For example: `{"uris": ["spotify:track:4iV5W9uYEdYUVa79Axb7Rh","spotify:track:1301WleyT98MSxVHPZCA6M", "spotify:episode:512ojhOuo1ktJprKbVcKyQ"]}`<br/>A maximum of 100 items can be added in one request. _**Note**: if the `uris` parameter is present in the query string, any URIs listed here in the body will be ignored._

  • positioninteger

    The position to insert the items, a zero-based index. For example, to insert the items in the first position: `position=0` ; to insert the items in the third position: `position=2`. If omitted, the items will be appended to the playlist. Items are added in the order they appear in the uris array. For example: `{"uris": ["spotify:track:4iV5W9uYEdYUVa79Axb7Rh","spotify:track:1301WleyT98MSxVHPZCA6M"], "position": 3}`

  • playlist_idstringObligatorio

    Playlist Id

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Change playlist detailsSPOTIFY_CHANGE_PLAYLIST_DETAILSAcción

Change a playlist's name and public/private state. (the user must, of course, own the playlist.)

Parámetros de entrada

  • namestring

    The new name for the playlist, for example `"My New Playlist Title"`

  • publicboolean

    If `true` the playlist will be public, if `false` it will be private.

  • descriptionstring

    Value for playlist description as displayed in Spotify Clients and in the Web API.

  • playlist_idstringObligatorio

    Playlist Id

  • collaborativeboolean

    If `true`, the playlist will become collaborative and other users will be able to modify the playlist in their Spotify client. <br/> _**Note**: You can only set `collaborative` to `true` on non-public playlists._

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Check if user follows artists or usersSPOTIFY_CHECK_IF_USER_FOLLOWS_ARTISTS_OR_USERSAcción

Check to see if the current user is following one or more artists or other spotify users.

Parámetros de entrada

  • idsstringObligatorio

    Ids

  • typestringObligatorioenum

    Type

    artistuser

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Check if users follow playlistSPOTIFY_CHECK_IF_USERS_FOLLOW_PLAYLISTAcción

Check to see if one or more spotify users are following a specified playlist.

Parámetros de entrada

  • idsstringObligatorio

    Ids

  • playlist_idstringObligatorio

    Playlist Id

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Check user s saved albumsSPOTIFY_CHECK_USER_S_SAVED_ALBUMSAcción

Check if one or more albums is already saved in the current spotify user's 'your music' library.

Parámetros de entrada

  • idsstringObligatorio

    Ids

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Check user s saved audiobooksSPOTIFY_CHECK_USER_S_SAVED_AUDIOBOOKSAcción

Check if one or more audiobooks are already saved in the current spotify user's library.

Parámetros de entrada

  • idsstringObligatorio

    Ids

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Check user s saved episodesSPOTIFY_CHECK_USER_S_SAVED_EPISODESAcción

This spotify api endpoint (in beta) checks if episodes are saved in a user's library. feedback and issues can be shared in the developer forum.

Parámetros de entrada

  • idsstringObligatorio

    Ids

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Check user s saved showsSPOTIFY_CHECK_USER_S_SAVED_SHOWSAcción

Check if one or more shows is already saved in the current spotify user's library.

Parámetros de entrada

  • idsstringObligatorio

    Ids

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Check user s saved tracksSPOTIFY_CHECK_USER_S_SAVED_TRACKSAcción

Check if one or more tracks is already saved in the current spotify user's 'your music' library.

Parámetros de entrada

  • idsstringObligatorio

    Ids

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create playlistSPOTIFY_CREATE_PLAYLISTAcción

Create a playlist for a spotify user. (the playlist will be empty until you [add tracks](/documentation/web-api/reference/add-tracks-to-playlist).) each user is generally limited to a maximum of 11000 playlists.

Parámetros de entrada

  • namestringObligatorio

    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.

  • publicboolean

    Defaults to `true`. If `true` the playlist will be public, if `false` it will be private. To be able to create private playlists, the user must have granted the `playlist-modify-private` [scope](/documentation/web-api/concepts/scopes/#list-of-scopes)

  • user_idstringObligatorio

    User Id

  • descriptionstring

    value for playlist description as displayed in Spotify Clients and in the Web API.

  • collaborativeboolean

    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](/documentation/web-api/concepts/scopes/#list-of-scopes)._

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Follow artists or usersSPOTIFY_FOLLOW_ARTISTS_OR_USERSAcción

Add the current user as a follower of one or more artists or other spotify users.

Parámetros de entrada

  • idsstring[]Obligatorio

    A JSON array of the artist or user [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids). For example: `{ids:["74ASZWbe4lXaubB36ztrGX", "08td7MxkoHQkXnWAYD8d6Q"]}`. A maximum of 50 IDs can be sent in one request. _**Note**: if the `ids` parameter is present in the query string, any IDs listed here in the body will be ignored._

  • typestringObligatorioenum

    Type

    artistuser

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Follow playlistSPOTIFY_FOLLOW_PLAYLISTAcción

Add the current user as a follower of a playlist.

Parámetros de entrada

  • publicboolean

    Defaults to `true`. If `true` the playlist will be included in user"s public playlists, if `false` it will remain private.

  • playlist_idstringObligatorio

    Playlist Id

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get a chapterSPOTIFY_GET_A_CHAPTERAcción

Get spotify catalog information for a single audiobook chapter. chapters are only available within the us, uk, canada, ireland, new zealand and australia markets.

Parámetros de entrada

  • idstringObligatorio

    Id

  • marketstring

    Market

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get albumSPOTIFY_GET_ALBUMAcción

Get spotify catalog information for a single album.

Parámetros de entrada

  • idstringObligatorio

    Id

  • marketstring

    Market

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get album tracksSPOTIFY_GET_ALBUM_TRACKSAcción

Get spotify catalog information about an album’s tracks. optional parameters can be used to limit the number of tracks returned.

Parámetros de entrada

  • idstringObligatorio

    Id

  • limitinteger

    Limit

  • marketstring

    Market

  • offsetinteger

    Offset

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get current user s playlistsSPOTIFY_GET_A_LIST_OF_CURRENT_USERS_PLAYLISTSAcción

Get a list of the playlists owned or followed by the current spotify user. <<DEPRECATED use get_current_user_s_playlists>>

Parámetros de entrada

  • limitinteger

    Limit

  • offsetinteger

    Offset

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get artistSPOTIFY_GET_AN_ARTISTAcción

Get spotify catalog information for a single artist identified by their unique spotify id. <<DEPRECATED use get_artist>>

Parámetros de entrada

  • idstringObligatorio

    Id

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get artist s albumsSPOTIFY_GET_AN_ARTISTS_ALBUMSAcción

Get spotify catalog information about an artist's albums. <<DEPRECATED use get_artist_s_albums>>

Parámetros de entrada

  • idstringObligatorio

    Id

  • limitinteger

    Limit

  • marketstring

    Market

  • offsetinteger

    Offset

  • include_groupsstring

    Include Groups

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get artist s top tracksSPOTIFY_GET_AN_ARTISTS_TOP_TRACKSAcción

Get spotify catalog information about an artist's top tracks by country. <<DEPRECATED use get_artist_s_top_tracks>>

Parámetros de entrada

  • idstringObligatorio

    Id

  • marketstring

    Market

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get an audiobookSPOTIFY_GET_AN_AUDIOBOOKAcción

Get spotify catalog information for a single audiobook. audiobooks are only available within the us, uk, canada, ireland, new zealand and australia markets.

Parámetros de entrada

  • idstringObligatorio

    Id

  • marketstring

    Market

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get artistSPOTIFY_GET_ARTISTAcción

Get spotify catalog information for a single artist identified by their unique spotify id.

Parámetros de entrada

  • idstringObligatorio

    Id

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get artist s albumsSPOTIFY_GET_ARTIST_S_ALBUMSAcción

Get spotify catalog information about an artist's albums.

Parámetros de entrada

  • idstringObligatorio

    Id

  • limitinteger

    Limit

  • marketstring

    Market

  • offsetinteger

    Offset

  • include_groupsstring

    Include Groups

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get artist s related artistsSPOTIFY_GET_ARTIST_S_RELATED_ARTISTSAcción

Get spotify catalog information about artists similar to a given artist. similarity is based on analysis of the spotify community's listening history.

Parámetros de entrada

  • idstringObligatorio

    Id

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get artist s top tracksSPOTIFY_GET_ARTIST_S_TOP_TRACKSAcción

Get spotify catalog information about an artist's top tracks by country.

Parámetros de entrada

  • idstringObligatorio

    Id

  • marketstring

    Market

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get show episodesSPOTIFY_GET_A_SHOWS_EPISODESAcción

Get spotify catalog information about an show’s episodes. optional parameters can be used to limit the number of episodes returned. <<DEPRECATED use get_show_episodes>>

Parámetros de entrada

  • idstringObligatorio

    Id

  • limitinteger

    Limit

  • marketstring

    Market

  • offsetinteger

    Offset

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get audiobook chaptersSPOTIFY_GET_AUDIOBOOK_CHAPTERSAcción

Get spotify catalog information about an audiobook's chapters. audiobooks are only available within the us, uk, canada, ireland, new zealand and australia markets.

Parámetros de entrada

  • idstringObligatorio

    Id

  • limitinteger

    Limit

  • marketstring

    Market

  • offsetinteger

    Offset

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get available devicesSPOTIFY_GET_A_USERS_AVAILABLE_DEVICESAcción

Get information about a user’s available spotify connect devices. some device models are not supported and will not be listed in the api response. <<DEPRECATED use get_available_devices>>

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get available devicesSPOTIFY_GET_AVAILABLE_DEVICESAcción

Get information about a user’s available spotify connect devices. some device models are not supported and will not be listed in the api response.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get available genre seedsSPOTIFY_GET_AVAILABLE_GENRE_SEEDSAcción

Retrieve a list of available genres seed parameter values for [recommendations](/documentation/web-api/reference/get-recommendations).

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get available marketsSPOTIFY_GET_AVAILABLE_MARKETSAcción

Get the list of markets where spotify is available.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get category s playlistsSPOTIFY_GET_CATEGORY_S_PLAYLISTSAcción

Get a list of spotify playlists tagged with a particular category.

Parámetros de entrada

  • limitinteger

    Limit

  • offsetinteger

    Offset

  • category_idstringObligatorio

    Category Id

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get currently playing trackSPOTIFY_GET_CURRENTLY_PLAYING_TRACKAcción

Get the object currently being played on the user's spotify account.

Parámetros de entrada

  • marketstring

    Market

  • additional_typesstring

    Additional Types

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get current user s playlistsSPOTIFY_GET_CURRENT_USER_S_PLAYLISTSAcción

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

Parámetros de entrada

  • limitinteger

    Limit

  • offsetinteger

    Offset

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get current user s profileSPOTIFY_GET_CURRENT_USER_S_PROFILEAcción

Get detailed profile information about the current user (including the current user's username).

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get current user s profileSPOTIFY_GET_CURRENT_USERS_PROFILEAcción

Get detailed profile information about the current user (including the current user's username). <<DEPRECATED use get_current_user_s_profile>>

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get episodeSPOTIFY_GET_EPISODEAcción

Get spotify catalog information for a single episode identified by its unique spotify id.

Parámetros de entrada

  • idstringObligatorio

    Id

  • marketstring

    Market

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get featured playlistsSPOTIFY_GET_FEATURED_PLAYLISTSAcción

Get a list of spotify featured playlists (shown, for example, on a spotify player's 'browse' tab).

Parámetros de entrada

  • limitinteger

    Limit

  • localestring

    Locale

  • offsetinteger

    Offset

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get followed artistsSPOTIFY_GET_FOLLOWED_ARTISTSAcción

Get the current user's followed artists.

Parámetros de entrada

  • typestringObligatorioenum

    Type

    artist
  • afterstring

    After

  • limitinteger

    Limit

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get playback stateSPOTIFY_GET_INFORMATION_ABOUT_THE_USERS_CURRENT_PLAYBACKAcción

Get information about the user’s current playback state, including track or episode, progress, and active device. <<DEPRECATED use get_playback_state>>

Parámetros de entrada

  • marketstring

    Market

  • additional_typesstring

    Additional Types

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get user s playlistsSPOTIFY_GET_LIST_USERS_PLAYLISTSAcción

Get a list of the playlists owned or followed by a spotify user. <<DEPRECATED use get_user_s_playlists>>

Parámetros de entrada

  • limitinteger

    Limit

  • offsetinteger

    Offset

  • user_idstringObligatorio

    User Id

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get new releasesSPOTIFY_GET_NEW_RELEASESAcción

Get a list of new album releases featured in spotify (shown, for example, on a spotify player’s “browse” tab).

Parámetros de entrada

  • limitinteger

    Limit

  • offsetinteger

    Offset

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get playback stateSPOTIFY_GET_PLAYBACK_STATEAcción

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

Parámetros de entrada

  • marketstring

    Market

  • additional_typesstring

    Additional Types

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get playlistSPOTIFY_GET_PLAYLISTAcción

Get a playlist owned by a spotify user.

Parámetros de entrada

  • fieldsstring

    Fields

  • marketstring

    Market

  • playlist_idstringObligatorio

    Playlist Id

  • additional_typesstring

    Additional Types

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get playlist cover imageSPOTIFY_GET_PLAYLIST_COVER_IMAGEAcción

Get the current image associated with a specific playlist.

Parámetros de entrada

  • playlist_idstringObligatorio

    Playlist Id

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get playlist itemsSPOTIFY_GET_PLAYLIST_ITEMSAcción

Get full details of the items of a playlist owned by a spotify user.

Parámetros de entrada

  • limitinteger

    Limit

  • fieldsstring

    Fields

  • marketstring

    Market

  • offsetinteger

    Offset

  • playlist_idstringObligatorio

    Playlist Id

  • additional_typesstring

    Additional Types

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get the user s queueSPOTIFY_GET_QUEUEAcción

Get the list of objects that make up the user's queue. <<DEPRECATED use get_the_user_s_queue>>

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get recently played tracksSPOTIFY_GET_RECENTLY_PLAYEDAcción

Get tracks from the current user's recently played tracks. **note**: currently doesn't support podcast episodes. <<DEPRECATED use get_recently_played_tracks>>

Parámetros de entrada

  • afterinteger

    After

  • limitinteger

    Limit

  • beforeinteger

    Before

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get recently played tracksSPOTIFY_GET_RECENTLY_PLAYED_TRACKSAcción

Get tracks from the current user's recently played tracks. **note**: currently doesn't support podcast episodes.

Parámetros de entrada

  • afterinteger

    After

  • limitinteger

    Limit

  • beforeinteger

    Before

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get recommendationsSPOTIFY_GET_RECOMMENDATIONSAcción

Recommendations are based on seed entity data, matched with similar artists and tracks. if data is ample, a track list and pool size are returned. for new or obscure artists and tracks, data may be insufficient for recommendations.

Parámetros de entrada

  • limitinteger

    Limit

  • marketstring

    Market

  • max_keyinteger

    Max Key

  • min_keyinteger

    Min Key

  • max_modeinteger

    Max Mode

  • min_modeinteger

    Min Mode

  • max_tempointeger

    Max Tempo

  • min_tempointeger

    Min Tempo

  • max_energyinteger

    Max Energy

  • min_energyinteger

    Min Energy

  • target_keyinteger

    Target Key

  • max_valenceinteger

    Max Valence

  • min_valenceinteger

    Min Valence

  • seed_genresstring

    Seed Genres

  • seed_tracksstring

    Seed Tracks

  • target_modeinteger

    Target Mode

  • max_livenessinteger

    Max Liveness

  • max_loudnessinteger

    Max Loudness

  • min_livenessinteger

    Min Liveness

  • min_loudnessinteger

    Min Loudness

  • seed_artistsstring

    Seed Artists

  • target_tempointeger

    Target Tempo

  • target_energyinteger

    Target Energy

  • max_popularityinteger

    Max Popularity

  • min_popularityinteger

    Min Popularity

  • target_valenceinteger

    Target Valence

  • max_duration_msinteger

    Max Duration Ms

  • max_speechinessinteger

    Max Speechiness

  • min_duration_msinteger

    Min Duration Ms

  • min_speechinessinteger

    Min Speechiness

  • target_livenessinteger

    Target Liveness

  • target_loudnessinteger

    Target Loudness

  • max_acousticnessinteger

    Max Acousticness

  • max_danceabilityinteger

    Max Danceability

  • min_acousticnessinteger

    Min Acousticness

  • min_danceabilityinteger

    Min Danceability

  • target_popularityinteger

    Target Popularity

  • max_time_signatureinteger

    Max Time Signature

  • min_time_signatureinteger

    Min Time Signature

  • target_duration_msinteger

    Target Duration Ms

  • target_speechinessinteger

    Target Speechiness

  • target_acousticnessinteger

    Target Acousticness

  • target_danceabilityinteger

    Target Danceability

  • max_instrumentalnessinteger

    Max Instrumentalness

  • min_instrumentalnessinteger

    Min Instrumentalness

  • target_time_signatureinteger

    Target Time Signature

  • target_instrumentalnessinteger

    Target Instrumentalness

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get several albumsSPOTIFY_GET_SEVERAL_ALBUMSAcción

Get spotify catalog information for multiple albums identified by their spotify ids.

Parámetros de entrada

  • idsstringObligatorio

    Ids

  • marketstring

    Market

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get several artistsSPOTIFY_GET_SEVERAL_ARTISTSAcción

Get spotify catalog information for several artists based on their spotify ids.

Parámetros de entrada

  • idsstringObligatorio

    Ids

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get several audiobooksSPOTIFY_GET_SEVERAL_AUDIOBOOKSAcción

Get spotify catalog information for several audiobooks identified by their spotify ids. audiobooks are only available within the us, uk, canada, ireland, new zealand and australia markets.

Parámetros de entrada

  • idsstringObligatorio

    Ids

  • marketstring

    Market

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get several browse categoriesSPOTIFY_GET_SEVERAL_BROWSE_CATEGORIESAcción

Get a list of categories used to tag items in spotify (on, for example, the spotify player’s “browse” tab).

Parámetros de entrada

  • limitinteger

    Limit

  • localestring

    Locale

  • offsetinteger

    Offset

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get several chaptersSPOTIFY_GET_SEVERAL_CHAPTERSAcción

Get spotify catalog information for several audiobook chapters identified by their spotify ids. chapters are only available within the us, uk, canada, ireland, new zealand and australia markets.

Parámetros de entrada

  • idsstringObligatorio

    Ids

  • marketstring

    Market

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get several episodesSPOTIFY_GET_SEVERAL_EPISODESAcción

Get spotify catalog information for several episodes based on their spotify ids.

Parámetros de entrada

  • idsstringObligatorio

    Ids

  • marketstring

    Market

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get several showsSPOTIFY_GET_SEVERAL_SHOWSAcción

Get spotify catalog information for several shows based on their spotify ids.

Parámetros de entrada

  • idsstringObligatorio

    Ids

  • marketstring

    Market

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get several tracksSPOTIFY_GET_SEVERAL_TRACKSAcción

Get spotify catalog information for multiple tracks based on their spotify ids.

Parámetros de entrada

  • idsstringObligatorio

    Ids

  • marketstring

    Market

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get several tracks audio featuresSPOTIFY_GET_SEVERAL_TRACKS_AUDIO_FEATURESAcción

Get audio features for multiple tracks based on their spotify ids.

Parámetros de entrada

  • idsstringObligatorio

    Ids

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get showSPOTIFY_GET_SHOWAcción

Get spotify catalog information for a single show identified by its unique spotify id.

Parámetros de entrada

  • idstringObligatorio

    Id

  • marketstring

    Market

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get show episodesSPOTIFY_GET_SHOW_EPISODESAcción

Get spotify catalog information about an show’s episodes. optional parameters can be used to limit the number of episodes returned.

Parámetros de entrada

  • idstringObligatorio

    Id

  • limitinteger

    Limit

  • marketstring

    Market

  • offsetinteger

    Offset

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get single browse categorySPOTIFY_GET_SINGLE_BROWSE_CATEGORYAcción

Get a single category used to tag items in spotify (on, for example, the spotify player’s “browse” tab).

Parámetros de entrada

  • localestring

    Locale

  • category_idstringObligatorio

    Category Id

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get currently playing trackSPOTIFY_GET_THE_USERS_CURRENTLY_PLAYING_TRACKAcción

Get the object currently being played on the user's spotify account. <<DEPRECATED use get_currently_playing_track>>

Parámetros de entrada

  • marketstring

    Market

  • additional_typesstring

    Additional Types

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get the user s queueSPOTIFY_GET_THE_USER_S_QUEUEAcción

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

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get trackSPOTIFY_GET_TRACKAcción

Get spotify catalog information for a single track identified by its unique spotify id.

Parámetros de entrada

  • idstringObligatorio

    Id

  • marketstring

    Market

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get track s audio analysisSPOTIFY_GET_TRACK_S_AUDIO_ANALYSISAcción

Get a low-level audio analysis for a track in the spotify catalog. the audio analysis describes the track’s structure and musical content, including rhythm, pitch, and timbre.

Parámetros de entrada

  • idstringObligatorio

    Id

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get track s audio featuresSPOTIFY_GET_TRACK_S_AUDIO_FEATURESAcción

Get audio feature information for a single track identified by its unique spotify id.

Parámetros de entrada

  • idstringObligatorio

    Id

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get user s playlistsSPOTIFY_GET_USER_S_PLAYLISTSAcción

Get a list of the playlists owned or followed by a spotify user.

Parámetros de entrada

  • limitinteger

    Limit

  • offsetinteger

    Offset

  • user_idstringObligatorio

    User Id

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get user s profileSPOTIFY_GET_USER_S_PROFILEAcción

Get public profile information about a spotify user.

Parámetros de entrada

  • user_idstringObligatorio

    User Id

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get user s profileSPOTIFY_GET_USERS_PROFILEAcción

Get public profile information about a spotify user. <<DEPRECATED use get_user_s_profile>>

Parámetros de entrada

  • user_idstringObligatorio

    User Id

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get user s saved albumsSPOTIFY_GET_USER_S_SAVED_ALBUMSAcción

Get a list of the albums saved in the current spotify user's 'your music' library.

Parámetros de entrada

  • limitinteger

    Limit

  • marketstring

    Market

  • offsetinteger

    Offset

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get user s saved audiobooksSPOTIFY_GET_USER_S_SAVED_AUDIOBOOKSAcción

Get a list of the audiobooks saved in the current spotify user's 'your music' library.

Parámetros de entrada

  • limitinteger

    Limit

  • offsetinteger

    Offset

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get user s saved episodesSPOTIFY_GET_USER_S_SAVED_EPISODESAcción

This api endpoint, currently in beta, allows retrieving episodes saved in a spotify user's library. changes may occur without notice. feedback and issues can be shared in spotify's developer forum.

Parámetros de entrada

  • limitinteger

    Limit

  • marketstring

    Market

  • offsetinteger

    Offset

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get user s saved showsSPOTIFY_GET_USER_S_SAVED_SHOWSAcción

Get a list of shows saved in the current spotify user's library. optional parameters can be used to limit the number of shows returned.

Parámetros de entrada

  • limitinteger

    Limit

  • offsetinteger

    Offset

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get user s saved tracksSPOTIFY_GET_USER_S_SAVED_TRACKSAcción

Get a list of the songs saved in the current spotify user's 'your music' library.

Parámetros de entrada

  • limitinteger

    Limit

  • marketstring

    Market

  • offsetinteger

    Offset

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get user s saved tracksSPOTIFY_GET_USERS_SAVED_TRACKSAcción

Get a list of the songs saved in the current spotify user's 'your music' library. <<DEPRECATED use get_user_s_saved_tracks>>

Parámetros de entrada

  • limitinteger

    Limit

  • marketstring

    Market

  • offsetinteger

    Offset

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get user s top artistsSPOTIFY_GET_USER_S_TOP_ARTISTSAcción

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

Parámetros de entrada

  • limitinteger

    Limit

  • offsetinteger

    Offset

  • time_rangestring

    Time Range

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get user s top artistsSPOTIFY_GET_USERS_TOP_ARTISTSAcción

Get the current user's top artists based on calculated affinity. <<DEPRECATED use get_user_s_top_artists>>

Parámetros de entrada

  • limitinteger

    Limit

  • offsetinteger

    Offset

  • time_rangestring

    Time Range

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get user s top tracksSPOTIFY_GET_USER_S_TOP_TRACKSAcción

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

Parámetros de entrada

  • limitinteger

    Limit

  • offsetinteger

    Offset

  • time_rangestring

    Time Range

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get user s top tracksSPOTIFY_GET_USERS_TOP_TRACKSAcción

Get the current user's top tracks based on calculated affinity. <<DEPRECATED use get_user_s_top_tracks>>

Parámetros de entrada

  • limitinteger

    Limit

  • offsetinteger

    Offset

  • time_rangestring

    Time Range

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Pause playbackSPOTIFY_PAUSE_PLAYBACKAcción

Pause playback on the user's account. this api only works for users who have spotify premium. the order of execution is not guaranteed when you use this api with other player api endpoints.

Parámetros de entrada

  • device_idstring

    Device Id

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Remove playlist itemsSPOTIFY_REMOVE_PLAYLIST_ITEMSAcción

Remove one or more items from a user's playlist.

Parámetros de entrada

  • tracksobject[]Obligatorio

    An array of objects containing [Spotify URIs](/documentation/web-api/concepts/spotify-uris-ids) of the tracks or episodes to remove. For example: `{ "tracks": [{ "uri": "spotify:track:4iV5W9uYEdYUVa79Axb7Rh" },{ "uri": "spotify:track:1301WleyT98MSxVHPZCA6M" }] }`. A maximum of 100 objects can be sent at once.

  • playlist_idstringObligatorio

    Playlist Id

  • snapshot_idstring

    The playlist"s snapshot ID against which you want to make the changes. The API will validate that the specified items exist and in the specified positions and make the changes, even if more recent changes have been made to the playlist.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Remove users saved albumsSPOTIFY_REMOVE_USERS_SAVED_ALBUMSAcción

Remove one or more albums from the current user's 'your music' library.

Parámetros de entrada

  • idsstring[]Obligatorio

    A JSON array of the [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids). For example: `["4iV5W9uYEdYUVa79Axb7Rh", "1301WleyT98MSxVHPZCA6M"]`<br/>A maximum of 50 items can be specified in one request. _**Note**: if the `ids` parameter is present in the query string, any IDs listed here in the body will be ignored._

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Remove user s saved audiobooksSPOTIFY_REMOVE_USER_S_SAVED_AUDIOBOOKSAcción

Remove one or more audiobooks from the spotify user's library.

Parámetros de entrada

  • idsstringObligatorio

    Ids

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Remove user s saved episodesSPOTIFY_REMOVE_USER_S_SAVED_EPISODESAcción

This api endpoint, currently in beta, allows for the removal of episodes from a user's library and may change without notice. feedback and issues can be shared on the spotify developer forum.

Parámetros de entrada

  • idsstring[]Obligatorio

    A JSON array of the [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids). <br/>A maximum of 50 items can be specified in one request. _**Note**: if the `ids` parameter is present in the query string, any IDs listed here in the body will be ignored._

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Remove user s saved showsSPOTIFY_REMOVE_USER_S_SAVED_SHOWSAcción

Delete one or more shows from current spotify user's library.

Parámetros de entrada

  • idsstring[]Obligatorio

    A JSON array of the [Spotify IDs](https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids). A maximum of 50 items can be specified in one request. *Note: if the `ids` parameter is present in the query string, any IDs listed here in the body will be ignored.*

  • marketstring

    Market

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Remove user s saved tracksSPOTIFY_REMOVE_USER_S_SAVED_TRACKSAcción

Remove one or more tracks from the current user's 'your music' library.

Parámetros de entrada

  • idsstring[]Obligatorio

    A JSON array of the [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids). For example: `["4iV5W9uYEdYUVa79Axb7Rh", "1301WleyT98MSxVHPZCA6M"]`<br/>A maximum of 50 items can be specified in one request. _**Note**: if the `ids` parameter is present in the query string, any IDs listed here in the body will be ignored._

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Save albums for current userSPOTIFY_SAVE_ALBUMS_FOR_CURRENT_USERAcción

Save one or more albums to the current user's 'your music' library.

Parámetros de entrada

  • idsstring[]Obligatorio

    A JSON array of the [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids). For example: `["4iV5W9uYEdYUVa79Axb7Rh", "1301WleyT98MSxVHPZCA6M"]`<br/>A maximum of 50 items can be specified in one request. _**Note**: if the `ids` parameter is present in the query string, any IDs listed here in the body will be ignored._

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Save albums for current userSPOTIFY_SAVE_ALBUMS_USERAcción

Save one or more albums to the current user's 'your music' library. <<DEPRECATED use save_albums_for_current_user>>

Parámetros de entrada

  • idsstring[]Obligatorio

    A JSON array of the [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids). For example: `["4iV5W9uYEdYUVa79Axb7Rh", "1301WleyT98MSxVHPZCA6M"]`<br/>A maximum of 50 items can be specified in one request. _**Note**: if the `ids` parameter is present in the query string, any IDs listed here in the body will be ignored._

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Save audiobooks for current userSPOTIFY_SAVE_AUDIOBOOKS_FOR_CURRENT_USERAcción

Save one or more audiobooks to the current spotify user's library.

Parámetros de entrada

  • idsstringObligatorio

    Ids

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Save episodes for current userSPOTIFY_SAVE_EPISODES_FOR_CURRENT_USERAcción

This api endpoint, currently in beta, allows saving episodes to a user's library. users are encouraged to provide feedback or report issues in the spotify developer forum.

Parámetros de entrada

  • idsstring[]Obligatorio

    A JSON array of the [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids). <br/>A maximum of 50 items can be specified in one request. _**Note**: if the `ids` parameter is present in the query string, any IDs listed here in the body will be ignored._

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Save shows for current userSPOTIFY_SAVE_SHOWS_FOR_CURRENT_USERAcción

Save one or more shows to current spotify user's library.

Parámetros de entrada

  • idsstring[]Obligatorio

    A JSON array of the [Spotify IDs](https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids). A maximum of 50 items can be specified in one request. *Note: if the `ids` parameter is present in the query string, any IDs listed here in the body will be ignored.*

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Save tracks for current userSPOTIFY_SAVE_TRACKS_FOR_CURRENT_USERAcción

Save one or more tracks to the current user's 'your music' library.

Parámetros de entrada

  • idsstring[]Obligatorio

    A JSON array of the [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids). For example: `["4iV5W9uYEdYUVa79Axb7Rh", "1301WleyT98MSxVHPZCA6M"]`<br/>A maximum of 50 items can be specified in one request. _**Note**: if the `ids` parameter is present in the query string, any IDs listed here in the body will be ignored._

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Search for itemSPOTIFY_SEARCHAcción

Get spotify catalog information about albums, artists, playlists, tracks, shows, episodes or audiobooks that match a keyword string. audiobooks are only available within the us, uk, canada, ireland, new zealand and australia markets. <<DEPRECATED use search_for_item>>

Parámetros de entrada

  • qstringObligatorio

    Q

  • typestring[]Obligatorio

    Type

  • limitinteger

    Limit

  • marketstring

    Market

  • offsetinteger

    Offset

  • include_externalstringenum

    Include External

    audio

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Search for itemSPOTIFY_SEARCH_FOR_ITEMAcción

Get spotify catalog information about albums, artists, playlists, tracks, shows, episodes or audiobooks that match a keyword string. audiobooks are only available within the us, uk, canada, ireland, new zealand and australia markets.

Parámetros de entrada

  • qstringObligatorio

    Q

  • typestring[]Obligatorio

    Type

  • limitinteger

    Limit

  • marketstring

    Market

  • offsetinteger

    Offset

  • include_externalstringenum

    Include External

    audio

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Seek to positionSPOTIFY_SEEK_TO_POSITIONAcción

Seeks to the given position in the user’s currently playing track. this api only works for users who have spotify premium. the order of execution is not guaranteed when you use this api with other player api endpoints.

Parámetros de entrada

  • device_idstring

    Device Id

  • position_msintegerObligatorio

    Position Ms

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Set playback volumeSPOTIFY_SET_PLAYBACK_VOLUMEAcción

Set the volume for the user’s current playback device. this api only works for users who have spotify premium. the order of execution is not guaranteed when you use this api with other player api endpoints.

Parámetros de entrada

  • device_idstring

    Device Id

  • volume_percentintegerObligatorio

    Volume Percent

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Set repeat modeSPOTIFY_SET_REPEAT_MODEAcción

Set the repeat mode for the user's playback. this api only works for users who have spotify premium. the order of execution is not guaranteed when you use this api with other player api endpoints.

Parámetros de entrada

  • statestringObligatorio

    State

  • device_idstring

    Device Id

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Skip to nextSPOTIFY_SKIP_TO_NEXTAcción

Skips to next track in the user’s queue. this api only works for users who have spotify premium. the order of execution is not guaranteed when you use this api with other player api endpoints.

Parámetros de entrada

  • device_idstring

    Device Id

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Skip to previousSPOTIFY_SKIP_TO_PREVIOUSAcción

Skips to previous track in the user’s queue. this api only works for users who have spotify premium. the order of execution is not guaranteed when you use this api with other player api endpoints.

Parámetros de entrada

  • device_idstring

    Device Id

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Skip to nextSPOTIFY_SKIP_USERS_PLAYBACK_TO_NEXT_TRACKAcción

Skips to next track in the user’s queue. this api only works for users who have spotify premium. the order of execution is not guaranteed when you use this api with other player api endpoints. <<DEPRECATED use skip_to_next>>

Parámetros de entrada

  • device_idstring

    Device Id

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Start resume playbackSPOTIFY_START_A_USERS_PLAYBACKAcción

Start a new context or resume current playback on the user's active device. this api only works for users who have spotify premium. the order of execution is not guaranteed when you use this api with other player api endpoints. <<DEPRECATED use start_resume_playback>>

Parámetros de entrada

  • urisstring[]

    Optional. A JSON array of the Spotify track URIs to play. For example: `{"uris": ["spotify:track:4iV5W9uYEdYUVa79Axb7Rh", "spotify:track:1301WleyT98MSxVHPZCA6M"]}`

  • offsetobject

    Optional. Indicates from where in the context playback should start. Only available when context_uri corresponds to an album or playlist object "position" is zero based and can’t be negative. Example: `"offset": {"position": 5}` "uri" is a string representing the uri of the item to start at. Example: `"offset": {"uri": "spotify:track:1301WleyT98MSxVHPZCA6M"}`

  • device_idstring

    Device Id

  • context_uristring

    Optional. Spotify URI of the context to play. Valid contexts are albums, artists & playlists. `{context_uri:"spotify:album:1Je1IMUlBXcx1Fz0WE7oPT"}`

  • position_msinteger

    Indicates from what position to start playback. Must be a positive number. Passing in a position that is greater than the length of the track will cause the player to start playing the next song.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Start resume playbackSPOTIFY_START_RESUME_PLAYBACKAcción

Start a new context or resume current playback on the user's active device. this api only works for users who have spotify premium. the order of execution is not guaranteed when you use this api with other player api endpoints.

Parámetros de entrada

  • urisstring[]

    Optional. A JSON array of the Spotify track URIs to play. For example: `{"uris": ["spotify:track:4iV5W9uYEdYUVa79Axb7Rh", "spotify:track:1301WleyT98MSxVHPZCA6M"]}`

  • offsetobject

    Optional. Indicates from where in the context playback should start. Only available when context_uri corresponds to an album or playlist object "position" is zero based and can’t be negative. Example: `"offset": {"position": 5}` "uri" is a string representing the uri of the item to start at. Example: `"offset": {"uri": "spotify:track:1301WleyT98MSxVHPZCA6M"}`

  • device_idstring

    Device Id

  • context_uristring

    Optional. Spotify URI of the context to play. Valid contexts are albums, artists & playlists. `{context_uri:"spotify:album:1Je1IMUlBXcx1Fz0WE7oPT"}`

  • position_msinteger

    Indicates from what position to start playback. Must be a positive number. Passing in a position that is greater than the length of the track will cause the player to start playing the next song.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Toggle playback shuffleSPOTIFY_TOGGLE_PLAYBACK_SHUFFLEAcción

Toggle shuffle on or off for user’s playback. this api only works for users who have spotify premium. the order of execution is not guaranteed when you use this api with other player api endpoints.

Parámetros de entrada

  • statebooleanObligatorio

    State

  • device_idstring

    Device Id

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Transfer playbackSPOTIFY_TRANSFER_PLAYBACKAcción

Transfer playback to a new device and optionally begin playback. this api only works for users who have spotify premium. the order of execution is not guaranteed when you use this api with other player api endpoints.

Parámetros de entrada

  • playboolean

    **true**: ensure playback happens on new device.<br/>**false** or not provided: keep the current playback state.

  • device_idsstring[]Obligatorio

    A JSON array containing the ID of the device on which playback should be started/transferred.<br/>For example:`{device_ids:["74ASZWbe4lXaubB36ztrGX"]}`<br/>_**Note**: Although an array is accepted, only a single device_id is currently supported. Supplying more than one will return `400 Bad Request`_

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Unfollow artists or usersSPOTIFY_UNFOLLOW_ARTISTS_OR_USERSAcción

Remove the current user as a follower of one or more artists or other spotify users.

Parámetros de entrada

  • idsstring[]Obligatorio

    A JSON array of the artist or user [Spotify IDs](/documentation/web-api/concepts/spotify-uris-ids). For example: `{ids:["74ASZWbe4lXaubB36ztrGX", "08td7MxkoHQkXnWAYD8d6Q"]}`. A maximum of 50 IDs can be sent in one request. _**Note**: if the `ids` parameter is present in the query string, any IDs listed here in the body will be ignored._

  • typestringObligatorioenum

    Type

    artistuser

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Unfollow playlistSPOTIFY_UNFOLLOW_PLAYLISTAcción

Remove the current user as a follower of a playlist.

Parámetros de entrada

  • playlist_idstringObligatorio

    Playlist Id

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update playlist itemsSPOTIFY_UPDATE_PLAYLIST_ITEMSAcción

To modify a playlist, use rearrange (with `range start`, `insert before`, `range length`, `snapshot id`) or replace items (`uris` in body/query). replace overwrites items. operations can't combine in one request; they are exclusive but share an endpoint.

Parámetros de entrada

  • urisstring[]

    Uris

  • playlist_idstringObligatorio

    Playlist Id

  • range_startinteger

    The position of the first item to be reordered.

  • snapshot_idstring

    The playlist"s snapshot ID against which you want to make the changes.

  • range_lengthinteger

    The amount of items to be reordered. Defaults to 1 if not set.<br/>The range of items to be reordered begins from the _range_start_ position, and includes the _range_length_ subsequent items.<br/>Example:<br/>To move the items at index 9-10 to the start of the playlist, _range_start_ is set to 9, and _range_length_ is set to 2.

  • insert_beforeinteger

    The position where the items should be inserted.<br/>To reorder the items to the end of the playlist, simply set _insert_before_ to the position after the last item.<br/>Examples:<br/>To reorder the first item to the last position in a playlist with 10 items, set _range_start_ to 0, and _insert_before_ to 10.<br/>To reorder the last item in a playlist with 10 items to the start of the playlist, set _range_start_ to 9, and _insert_before_ to 0.

Parámetros de salida

  • dataobjectObligatorio
  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Triggers (3)

Los triggers son eventos externos que pueden iniciar un flujo en tus agentes (ej: nuevo email, mensaje recibido, registro creado).

New Device AddedSPOTIFY_NEW_DEVICE_TRIGGERTrigger

Triggers when a new device is added.

Configuración

  • intervalnumber

    Periodic Interval to Check for Updates & Send a Trigger in Minutes

Payload del evento

  • deviceobjectObligatorio

    Device details

  • event_typestringObligatorio

    Type of device event (added/removed)

Instrucciones

**Instructions for Setting Up the Trigger:** - Make sure you have authorized access to the Spotify API.

Spotify Playlist Item ChangeSPOTIFY_PLAYLIST_ITEM_TRIGGERTrigger

Triggers when songs are added to or removed from a Spotify playlist.

Configuración

  • intervalnumber

    Periodic Interval to Check for Updates & Send a Trigger in Minutes

  • playlist_idstringObligatorio

    The ID of the Spotify playlist

Payload del evento

  • event_typestringObligatorio

    Type of playlist item event (added/removed)

  • trackobjectObligatorio

    Track details

Instrucciones

**Instructions for Setting Up the Trigger:** 1. Provide the Spotify Playlist ID. You can find this in the playlist's URL (e.g., the string after `playlist/` and before `?`). 2. Ensure you have authorized Mercury to access your Spotify account, specifically the permissions needed to read playlists. 3. This trigger will fire when tracks are added or removed.

New Playlist Created or DeletedSPOTIFY_PLAYLIST_TRIGGERTrigger

Triggers when a new playlist is created or deleted.

Configuración

  • intervalnumber

    Periodic Interval to Check for Updates & Send a Trigger in Minutes

Payload del evento

  • event_typestringObligatorio

    Type of playlist event (created/deleted)

  • playlistobjectObligatorio

    Playlist details

Instrucciones

**Instructions for Setting Up the Trigger:** - Make sure you have authorized access to the Spotify API.