Use the getGroups command in the groups namespace to get information about groups and players in a household.
Request Parameters
This command requires a householdId in the header to determine its targeted recipient. See the Control documentation for descriptions of parameters in the header.
Endpoint
GET
|
1 |
/households/{householdId}/groups |
Response
Returns a groups object type.
In the event of a failure, returns a globalError.
Example
Response
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 |
{ "players": [ { "name": "p5", "websocketUrl": "wss://11.0.11.7:1443/websocket/api", "deviceIds": [ "RINCON_7DQQGH13GH4Q12345" ], "id": "RINCON_7DQQGH13GH4Q12345", "icon": "livingroom" }, { "name": "pb", "websocketUrl": "wss://11.0.11.14:1443/websocket/api", "deviceIds": [ "RINCON_Z0X1234G34H654321", "RINCON_070E58F007BC01499", "RINCON_A9E93789CRT201577" ], "id": "RINCON_Z0X1234G34H654321", "icon": "livingroom" } ], "groups": [ { "playerIds": [ "RINCON_7DQQGH13GH4Q12345" ], "playbackState": "PLAYBACK_STATE_IDLE", "coordinatorId": "RINCON_7DQQGH13GH4Q12345", "id": "RINCON_7DQQGH13GH4Q12345:218", "name": "p5" }, { "playerIds": [ "RINCON_Z0X1234G34H654321" ], "playbackState": "PLAYBACK_STATE_IDLE", "coordinatorId": "RINCON_Z0X1234G34H654321", "id": "RINCON_Z0X1234G34H654321:15", "name": "pb" } ] } |