Spotify integration (Design, Social). Imported from open-connector.
https://api.spotify.com/v1/me
| Param | Type | Required | Description |
|---|---|---|---|
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
/search
| Param | Type | Required | Description |
|---|---|---|---|
| query | string | required | Spotify search query. |
| types | array | required | Spotify item types to search. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
/me/top/tracks
| Param | Type | Required | Description |
|---|---|---|---|
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/me/top/artists
| Param | Type | Required | Description |
|---|---|---|---|
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
/playlists/{playlistId}
| Param | Type | Required | Description |
|---|---|---|---|
| playlistId | string | required | Spotify playlist ID. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/playlists/{playlistId}/tracks
| Param | Type | Required | Description |
|---|---|---|---|
| playlistId | string | required | Spotify playlist ID. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/albums/{albumId}
| Param | Type | Required | Description |
|---|---|---|---|
| albumId | string | required | Spotify album ID. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/albums/{albumId}/tracks
| Param | Type | Required | Description |
|---|---|---|---|
| albumId | string | required | Spotify album ID. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/artists/{artistId}
| Param | Type | Required | Description |
|---|---|---|---|
| artistId | string | required | Spotify artist ID. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
/artists/{artistId}/albums
| Param | Type | Required | Description |
|---|---|---|---|
| artistId | string | required | Spotify artist ID. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/artists/{artistId}/related-artists
| Param | Type | Required | Description |
|---|---|---|---|
| artistId | string | required | Spotify artist ID. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
/artists/{artistId}/top-tracks
| Param | Type | Required | Description |
|---|---|---|---|
| artistId | string | required | Spotify artist ID. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | required | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/tracks/{trackId}
| Param | Type | Required | Description |
|---|---|---|---|
| trackId | string | required | Spotify track ID. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/tracks
| Param | Type | Required | Description |
|---|---|---|---|
| trackIds | array | required | Spotify track IDs. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/artists
| Param | Type | Required | Description |
|---|---|---|---|
| artistIds | array | required | Spotify artist IDs. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
/albums
| Param | Type | Required | Description |
|---|---|---|---|
| albumIds | array | required | Spotify album IDs. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/audio-features/{trackId}
| Param | Type | Required | Description |
|---|---|---|---|
| trackId | string | required | Spotify track ID. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/audio-features
| Param | Type | Required | Description |
|---|---|---|---|
| trackIds | array | required | Spotify track IDs. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/audio-analysis/{trackId}
| Param | Type | Required | Description |
|---|---|---|---|
| trackId | string | required | Spotify track ID. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/recommendations
| Param | Type | Required | Description |
|---|---|---|---|
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
/recommendations/available-genre-seeds
| Param | Type | Required | Description |
|---|---|---|---|
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
/markets
| Param | Type | Required | Description |
|---|---|---|---|
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
/playlists/{playlistId}/images
| Param | Type | Required | Description |
|---|---|---|---|
| playlistId | string | required | Spotify playlist ID. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/users/{userId}/playlists
| Param | Type | Required | Description |
|---|---|---|---|
| userId | string | required | Spotify user ID. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| name | string | required | Playlist name. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/playlists/{playlistId}
| Param | Type | Required | Description |
|---|---|---|---|
| playlistId | string | required | Spotify playlist ID. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/playlists/{playlistId}/tracks
| Param | Type | Required | Description |
|---|---|---|---|
| playlistId | string | required | Spotify playlist ID. |
| uris | array | required | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/playlists/{playlistId}/followers
| Param | Type | Required | Description |
|---|---|---|---|
| playlistId | string | required | Spotify playlist ID. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/playlists/{playlistId}/followers
| Param | Type | Required | Description |
|---|---|---|---|
| playlistId | string | required | Spotify playlist ID. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/shows/{showId}
| Param | Type | Required | Description |
|---|---|---|---|
| showId | string | required | Spotify show ID. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/shows/{showId}/episodes
| Param | Type | Required | Description |
|---|---|---|---|
| showId | string | required | Spotify show ID. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/episodes/{episodeId}
| Param | Type | Required | Description |
|---|---|---|---|
| episodeId | string | required | Spotify episode ID. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/episodes
| Param | Type | Required | Description |
|---|---|---|---|
| episodeIds | array | required | Spotify episode IDs. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/audiobooks/{audiobookId}
| Param | Type | Required | Description |
|---|---|---|---|
| audiobookId | string | required | Spotify audiobook ID. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/audiobooks/{audiobookId}/chapters
| Param | Type | Required | Description |
|---|---|---|---|
| audiobookId | string | required | Spotify audiobook ID. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/chapters/{chapterId}
| Param | Type | Required | Description |
|---|---|---|---|
| chapterId | string | required | Spotify chapter ID. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/audiobooks
| Param | Type | Required | Description |
|---|---|---|---|
| audiobookIds | array | required | Spotify audiobook IDs. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/chapters
| Param | Type | Required | Description |
|---|---|---|---|
| chapterIds | array | required | Spotify chapter IDs. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/shows
| Param | Type | Required | Description |
|---|---|---|---|
| showIds | array | required | Spotify show IDs. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/browse/featured-playlists
| Param | Type | Required | Description |
|---|---|---|---|
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/browse/new-releases
| Param | Type | Required | Description |
|---|---|---|---|
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
/browse/categories
| Param | Type | Required | Description |
|---|---|---|---|
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
/browse/categories/{categoryId}
| Param | Type | Required | Description |
|---|---|---|---|
| categoryId | string | required | Spotify browse category ID. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
/browse/categories/{categoryId}/playlists
| Param | Type | Required | Description |
|---|---|---|---|
| categoryId | string | required | Spotify browse category ID. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/users/{userId}
| Param | Type | Required | Description |
|---|---|---|---|
| userId | string | required | Spotify user ID. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
/me/playlists
| Param | Type | Required | Description |
|---|---|---|---|
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/users/{userId}/playlists
| Param | Type | Required | Description |
|---|---|---|---|
| userId | string | required | Spotify user ID. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/me/albums
| Param | Type | Required | Description |
|---|---|---|---|
| albumIds | array | required | Spotify album IDs. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/me/albums
| Param | Type | Required | Description |
|---|---|---|---|
| albumIds | array | required | Spotify album IDs. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/me/audiobooks
| Param | Type | Required | Description |
|---|---|---|---|
| audiobookIds | array | required | Spotify audiobook IDs. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/me/audiobooks
| Param | Type | Required | Description |
|---|---|---|---|
| audiobookIds | array | required | Spotify audiobook IDs. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/me/episodes
| Param | Type | Required | Description |
|---|---|---|---|
| episodeIds | array | required | Spotify episode IDs. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/me/episodes
| Param | Type | Required | Description |
|---|---|---|---|
| episodeIds | array | required | Spotify episode IDs. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/me/shows
| Param | Type | Required | Description |
|---|---|---|---|
| showIds | array | required | Spotify show IDs. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/me/shows
| Param | Type | Required | Description |
|---|---|---|---|
| showIds | array | required | Spotify show IDs. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/me/tracks
| Param | Type | Required | Description |
|---|---|---|---|
| trackIds | array | required | Spotify track IDs. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/me/tracks
| Param | Type | Required | Description |
|---|---|---|---|
| trackIds | array | required | Spotify track IDs. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/me/albums
| Param | Type | Required | Description |
|---|---|---|---|
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/me/audiobooks
| Param | Type | Required | Description |
|---|---|---|---|
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/me/episodes
| Param | Type | Required | Description |
|---|---|---|---|
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/me/shows
| Param | Type | Required | Description |
|---|---|---|---|
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/me/tracks
| Param | Type | Required | Description |
|---|---|---|---|
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/me/albums/contains
| Param | Type | Required | Description |
|---|---|---|---|
| albumIds | array | required | Spotify album IDs. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/me/audiobooks/contains
| Param | Type | Required | Description |
|---|---|---|---|
| audiobookIds | array | required | Spotify audiobook IDs. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/me/episodes/contains
| Param | Type | Required | Description |
|---|---|---|---|
| episodeIds | array | required | Spotify episode IDs. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/me/shows/contains
| Param | Type | Required | Description |
|---|---|---|---|
| showIds | array | required | Spotify show IDs. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/me/tracks/contains
| Param | Type | Required | Description |
|---|---|---|---|
| trackIds | array | required | Spotify track IDs. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/me/following
| Param | Type | Required | Description |
|---|---|---|---|
| ids | array | required | Spotify artist or user IDs. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| type | string | required | Whether the follow target is an artist or user. |
/me/following
| Param | Type | Required | Description |
|---|---|---|---|
| ids | array | required | Spotify artist or user IDs. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| type | string | required | Whether the follow target is an artist or user. |
/me/following
| Param | Type | Required | Description |
|---|---|---|---|
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
/me/following/contains
| Param | Type | Required | Description |
|---|---|---|---|
| ids | array | required | Spotify artist or user IDs. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| type | string | required | Whether the follow target is an artist or user. |
/playlists/{playlistId}/followers/contains
| Param | Type | Required | Description |
|---|---|---|---|
| playlistId | string | required | Spotify playlist ID. |
| userIds | array | required | Spotify user IDs. |
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/me/player/devices
| Param | Type | Required | Description |
|---|---|---|---|
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/me/player/pause
| Param | Type | Required | Description |
|---|---|---|---|
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/me/player/seek
| Param | Type | Required | Description |
|---|---|---|---|
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | required | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/me/player/repeat
| Param | Type | Required | Description |
|---|---|---|---|
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | required | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/me/player/volume
| Param | Type | Required | Description |
|---|---|---|---|
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | required | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/me/player/next
| Param | Type | Required | Description |
|---|---|---|---|
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
/me/player/previous
| Param | Type | Required | Description |
|---|---|---|---|
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
/me/player/shuffle
| Param | Type | Required | Description |
|---|---|---|---|
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/me/player
| Param | Type | Required | Description |
|---|---|---|---|
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| deviceIds | array | required | Spotify Connect device IDs. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/me/player/queue
| Param | Type | Required | Description |
|---|---|---|---|
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| uri | string | required | Spotify URI. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/me/player
| Param | Type | Required | Description |
|---|---|---|---|
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/me/player/currently-playing
| Param | Type | Required | Description |
|---|---|---|---|
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/me/player/recently-played
| Param | Type | Required | Description |
|---|---|---|---|
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |
/me/player/queue
| Param | Type | Required | Description |
|---|---|---|---|
| uris | array | optional | Spotify URIs in the order Spotify should use. |
| description | string | optional | Playlist description. |
| public | boolean | optional | Whether the playlist should be public. |
| collaborative | boolean | optional | Whether the playlist should be collaborative. |
| market | string | optional | An ISO 3166-1 alpha-2 country code or from_token to apply market filtering. |
| country | string | optional | An ISO 3166-1 alpha-2 country code. |
| locale | string | optional | Locale code such as en_US used by Spotify browse endpoints. |
| limit | integer | optional | Maximum number of items to return. |
| offset | integer | optional | Zero-based index of the first item to return. |
| timeRange | string | optional | Spotify top-items time range. |
| includeGroups | array | optional | Album groups to include. |
| seedArtists | array | optional | Artist seeds used by Spotify recommendations. |
| seedTracks | array | optional | Track seeds used by Spotify recommendations. |
| seedGenres | array | optional | Genre seeds used by Spotify recommendations. |
| includeExternalAudio | boolean | optional | Whether externally hosted audio should be included in search results. |
| position | integer | optional | Zero-based playlist insert position. |
| rangeStart | integer | optional | The position of the first item to reorder. |
| insertBefore | integer | optional | The position where the reordered items should be inserted. |
| rangeLength | integer | optional | The number of items to reorder. |
| snapshotId | string | optional | Playlist snapshot ID. |
| after | integer | optional | Unix timestamp in milliseconds or cursor after which to return items. |
| before | integer | optional | Unix timestamp in milliseconds before which to return items. |
| deviceId | string | optional | Spotify Connect device ID. |
| state | string | optional | Playback repeat or shuffle state. |
| volumePercent | integer | optional | Volume percentage from 0 to 100. |
| positionMs | integer | optional | Playback position in milliseconds. |
| play | boolean | optional | Whether playback should start after transfer. |
| contextUri | string | optional | Spotify context URI to play. |
| additionalTypes | array | optional | Additional item types for playback endpoints. |
| timestamp | string | optional | ISO timestamp for featured playlist lookup. |
| timestampedTrackIds | array | optional | Timestamped track IDs for saved-track import. |