These endpoints are in Beta. While we encourage you to build with them, a situation may arise where we need to disable some or all of the functionality and/or change how they work without prior notice. Please report any issues via our GitHub issue tracker.

Endpoint

GET https://api.spotify.com/v1/me/player/devices

Request Parameters

Header Fields

Header Field Value
Authorization Required. A valid access token from the Spotify Accounts service: see the Web API Authorization Guide for details. The access token must have been issued on behalf of a user. The access token must have the user-read-playback-state scope authorized in order to read information.

Response Format

A successful request will return a 200 OK response code with a json payload that contains the device objects (see below). When no available devices are found, the request will return a 200 OK response with an empty devices list.

Example

curl -X GET "https://api.spotify.com/v1/me/player/devices" -H "Authorization: Bearer {your access token}"
{
  "devices" : [ {
    "id" : "5fbb3ba6aa454b5534c4ba43a8c7e8e45a63ad0e",
    "is_active" : false,
    "is_private_session": true,
    "is_restricted" : false,
    "name" : "My fridge",
    "type" : "Computer",
    "volume_percent" : 100
  } ]
}

Try it

Payload Object

Key Value Type Value Description
devices array of Device objects Required. A list of 0..n Device objects

Device Object

Key Value Type Value Description
id string The device ID. This may be null.
is_active boolean If this device is the currently active device.
is_private_session boolean If this device is currently in a private session.
is_restricted boolean Whether controlling this device is restricted. At present if this is “true” then no Web API commands will be accepted by this device.
name string The name of the device.
type string Device type, such as “Computer”, “Smartphone” or “Speaker”.
volume_percent integer The current volume in percent. This may be null.