SOsonos
households

getHouseholds

The getHouseholds command requests information on the households that can be acted upon, based upon the access token used when calling this API. There are no parameters for this command.

If successful, Sonos responds with an array of household objects.

get/households

Request

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

This command returns a list of households.

Changes

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