Skip to content
DocumentationAPI Reference

Playlists

Get Playlist
client.playlists.retrieve(stringplaylistID, PlaylistRetrieveParams { additional_types, fields, market } query?, RequestOptionsoptions?): PlaylistRetrieveResponse { id, collaborative, description, 11 more }
GET/playlists/{playlist_id}
Change Playlist Details
client.playlists.update(stringplaylistID, PlaylistUpdateParams { collaborative, description, name, published } body?, RequestOptionsoptions?): void
PUT/playlists/{playlist_id}

PlaylistsTracks

Get Playlist Items
client.playlists.tracks.list(stringplaylistID, TrackListParams { additional_types, fields, limit, 2 more } query?, RequestOptionsoptions?): CursorURLPage<PlaylistTrackObject { added_at, added_by, is_local, 2 more } >
GET/playlists/{playlist_id}/tracks
Add Items to Playlist
client.playlists.tracks.add(stringplaylistID, TrackAddParams { position, published, uris } body?, RequestOptionsoptions?): TrackAddResponse { snapshot_id }
POST/playlists/{playlist_id}/tracks
Update Playlist Items
client.playlists.tracks.update(stringplaylistID, TrackUpdateParams { insert_before, published, range_length, 3 more } body?, RequestOptionsoptions?): TrackUpdateResponse { snapshot_id }
PUT/playlists/{playlist_id}/tracks
Remove Playlist Items
client.playlists.tracks.remove(stringplaylistID, TrackRemoveParams { tracks, published, snapshot_id } body, RequestOptionsoptions?): TrackRemoveResponse { snapshot_id }
DELETE/playlists/{playlist_id}/tracks

PlaylistsFollowers

Follow Playlist
client.playlists.followers.follow(stringplaylistID, FollowerFollowParams { published } body?, RequestOptionsoptions?): void
PUT/playlists/{playlist_id}/followers
Unfollow Playlist
client.playlists.followers.unfollow(stringplaylistID, RequestOptionsoptions?): void
DELETE/playlists/{playlist_id}/followers
Check if Current User Follows Playlist
client.playlists.followers.check(stringplaylistID, FollowerCheckParams { ids } query?, RequestOptionsoptions?): FollowerCheckResponse
GET/playlists/{playlist_id}/followers/contains

PlaylistsImages

Get Playlist Cover Image
client.playlists.images.list(stringplaylistID, RequestOptionsoptions?): ImageListResponse { height, url, width, published }
GET/playlists/{playlist_id}/images
Add Custom Playlist Cover Image
client.playlists.images.update(stringplaylistID, "string" | "ArrayBuffer" | "ArrayBufferView" | 2 morebody, RequestOptionsoptions?): Response
PUT/playlists/{playlist_id}/images