getFavorites

get

{protocol}://api.ws.sonos.com/control/api/{version}/households/{householdId}/favorites

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.

Responses

200Returns a favoritesList object, which is an array of favorite objects with a version number. In the event of a failure, returns a globalError.

400Returns a favoritesList object, which is an array of favorite objects with a version number. In the event of a failure, returns a globalError.

401Returns a favoritesList object, which is an array of favorite objects with a version number. In the event of a failure, returns a globalError.

403Returns a favoritesList object, which is an array of favorite objects with a version number. In the event of a failure, returns a globalError.

404Returns a favoritesList object, which is an array of favorite objects with a version number. In the event of a failure, returns a globalError.

499Returns a favoritesList object, which is an array of favorite objects with a version number. In the event of a failure, returns a globalError.

500Returns a favoritesList object, which is an array of favorite objects with a version number. In the event of a failure, returns a globalError.

503Returns a favoritesList object, which is an array of favorite objects with a version number. In the event of a failure, returns a globalError.