favorites > getFavorites

Use the getFavorites command in the favorites namespace to get the list of Sonos favorites for a household. The player limits the number of Sonos favorites to 70.



Request parameters

This command requires a householdId to determine the target of the command. See the Control documentation for details.


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

In the event of a failure, returns a globalError.

favoritesList object

The favoritesList object consists of the fields described below.

Parameter Type Value
version string The new version string. Sonos updates this version whenever the Sonos favorites change for the household. Your app can then send a getFavorites command to receive the new list of favorites.
items array A unique value, generated by the player, for each revision of Sonos favorites.