SOsonos
favorites

getFavorites

Use the getFavorites command in the favorites namespace to get the list of Sonos favorites for a household. Favorites do not include pinned items (any non-playable containers pinned to My Sonos) or Sonos playlists. See the Save your favorites section in the Sonos user guide and Add favorites for details. The player limits the number of Sonos favorites to 70. An array of objects is returned such that a developer can implement the favorites picker from the Sonos controller.

get/households/{householdId}/favorites

Request

  • Base URL
    https://api.ws.sonos.com/control/api/v1
  • URL
    https://api.ws.sonos.com/control/api/v1/households/{householdId}/favorites
  • Auth
    OAuth 2 and HTTP bearer and API key in header X-Sonos-Api-Key
    Authorization code: https://api.sonos.com/login/v3/oauth
    Token URL: https://api.sonos.com/login/v3/oauth/access scopes: playback-control-all

Response

Returns a favoritesList object, which is an array of favorite objects with a version number.

In the event of a failure, returns a globalError.

versionstring required

This is the same version string used in the ETag Response Header.

Changes

No recorded changes to this operation across all 1 revision of this API.