Skip to content

Spotify

Spotify is a popular music streaming service that offers a vast library of songs, podcasts, and playlists for users to enjoy.

Type: spotify/v1


Connections

Version: 1

OAuth2 Authorization Code

Properties

NameLabelTypeDescriptionRequired
clientIdClient IdSTRINGtrue
clientSecretClient SecretSTRINGtrue

Actions

Play/Resume Playback

Name: startResumePlayback

Start or resume current playback on an active device.

Properties

NameLabelTypeDescriptionRequired
deviceIdDevice IDSTRINGfalse
context_uriContext UriSTRINGSpotify URI of the context to play (album, artist, playlist).false
urisTracksARRAY
Items [STRING]
Spotify track URIs to play.false
position_msPositionINTEGERThe position in milliseconds to start playback from.false

Example JSON Structure

{
"label" : "Play/Resume Playback",
"name" : "startResumePlayback",
"parameters" : {
"deviceId" : "",
"context_uri" : "",
"uris" : [ "" ],
"position_ms" : 1
},
"type" : "spotify/v1/startResumePlayback"
}

Output

This action does not produce any output.

Add Items to a Playlist

Name: addItemsToPlaylist

Adds one or more items to your playlist.

Properties

NameLabelTypeDescriptionRequired
playlist_idPlaylist IDSTRINGtrue
urisTracksARRAY
Items [STRING]
true
positionPositionINTEGERPosition to insert the items, a zero-based index.false

Example JSON Structure

{
"label" : "Add Items to a Playlist",
"name" : "addItemsToPlaylist",
"parameters" : {
"playlist_id" : "",
"uris" : [ "" ],
"position" : 1
},
"type" : "spotify/v1/addItemsToPlaylist"
}

Output

Type: OBJECT

Properties

NameTypeDescription
snapshot_idSTRINGThe snapshot ID of the playlist.

Output Example

{
"snapshot_id" : ""
}

Create Playlist

Name: createPlaylist

Creates a new playlist

Properties

NameLabelTypeDescriptionRequired
nameNameSTRINGThe name for the new playlist.true
descriptionDescriptionSTRINGThe description for the new playlist.false
publicPublicBOOLEAN
Options true, false
The public status for the new playlist.true
collaborativeCollaborativeBOOLEAN
Options true, false
If the playlist is collaborative or not.true

Example JSON Structure

{
"label" : "Create Playlist",
"name" : "createPlaylist",
"parameters" : {
"name" : "",
"description" : "",
"public" : false,
"collaborative" : false
},
"type" : "spotify/v1/createPlaylist"
}

Output

Type: OBJECT

Properties

NameTypeDescription
collaborativeBOOLEAN
Options true, false
Indicates if the owner allows other users to modify the playlist.
descriptionSTRINGThe playlist description.
external_urlsOBJECT
Properties {STRING(spotify)}
Known external URLs for this playlist.
hrefSTRINGA link to the Web API endpoint providing full details of the playlist.
idSTRINGThe Spotify ID for the playlist.
nameSTRINGThe name of the playlist.
typeSTRINGThe object type: ‘playlist’.
uriSTRINGThe Spotify URI for the playlist.
ownerOBJECT
Properties {STRING(href), STRING(id), STRING(type), STRING(uri)}
The user who owns the playlist.
publicBOOLEAN
Options true, false
The playlist’s public/private status.

Output Example

{
"collaborative" : false,
"description" : "",
"external_urls" : {
"spotify" : ""
},
"href" : "",
"id" : "",
"name" : "",
"type" : "",
"uri" : "",
"owner" : {
"href" : "",
"id" : "",
"type" : "",
"uri" : ""
},
"public" : false
}