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.

Query Params
boolean

Lookup all the households, connected or disconnected, when set to false.

Headers
uuid
deprecated

Client API Key for the integration. Required in V1 but deprecated in V2.

uuid

Correlation UUID for data tracking purposes

Responses

400

The given resource/object identifier is invalid

401

A client has not provided authorization credentials to perform a command

403

A client does not have the correct permissions to perform a command

404

A command was targeted to a group that no longer is the same group

499

Indicates there was an error occurred when performing a command

500

Sonos has experience an unexpected condition it is unable to recover from

503

Player is unable to reach the service.

Language
Credentials
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json