SOsonos
households

getHousehold

The getHousehold command requests information on the specific household represented by provided resourceId 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 a household object.

get/households/{householdId}

Request

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

idstring required

This is the householdId, used in household targeted commands such as getGroups.

namestring nullable

This is a human friendly name assigned by Sonos or the user. Some user households might be unnamed, in which case this field is omitted from the response.

swVersionstring nullable

The max supported firmware version reported by devices connected with this household.

ownerLuidstring nullable

This is the luid (aka. sonosId, userId, id created by WWW db) of the account to which the players in the household are registered (i.e., the OWNER).

Changes

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