Skip to content
Web API •References / Player / Get Available Devices

Get Available Devices

Get information about a user’s available devices.

Authorization scopes

Request

GET
/me/player/devices

Response

A set of devices

  • Required
    • id
      string
      Nullable

      The device ID.

    • 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

      A human-readable name for the device. Some devices have a name that the user can configure (e.g. "Loudest speaker") and some devices have a generic name associated with the manufacturer or device model.

      Example value: "Kitchen speaker"
    • type
      string

      Device type, such as "computer", "smartphone" or "speaker".

      Example value: "computer"
    • volume_percent
      integer
      Nullable

      The current volume in percent.

      Example value: 59Range: 0 - 100