API Reference
Dev Portal

getGroups

get
{protocol}://api.ws.sonos.com/control/api/{version}/households//groups

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Target householdId

Query Params
boolean

This used to control whether the groups response contained the deviceInfo object.
As of version 1.38.0, this parameter is deprecated and ignored. The groups response
always includes the deviceInfo object.

Headers
uuid
deprecated

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

uuid

Correlation UUID for data tracking purposes

Responses

Updated 26 days ago

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

Updated 26 days ago