SOsonos
groups

getGroups

Use the getGroups command in the groups namespace to get information about groups and players in a household.

get/households/{householdId}/groups

Request

  • Base URL
    https://api.ws.sonos.com/control/api/v1
  • URL
    https://api.ws.sonos.com/control/api/v1/households/{householdId}/groups
  • 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

The groups object in the groups namespace describes the current set of logical players and groups in the household. Use the getGroups command to get a groups object.

partialboolean nullable

Describes whether this is a partial output (where players or groups were dropped). Players and groups can be dropped from the output if they are determined to be invalid according to Sonos household rules. Invalid groups can appear when the household is in a transient state during a grouping operation.

Changes

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