Endpoints for recalling scenes and controlling groups of devices at once through the Vendor API. Use these for whole-room or whole-area control instead of commanding each device individually.
See Authentication for authentication.
Base & Authentication
| Item | Value |
|---|---|
| Base URL | http://<gateway-ip>:5000/api/vendor |
| Auth header | Authorization: Bearer <apiKey> |
List scenes
GET /scenes — operation: read
{
"success": true,
"data": [
{ "id": "da7a7772-...", "name": "Daytime", "type": "casambi_scene", "space": null }
]
}
Activate a scene
POST /scenes/:id/activate — operation: control
Send an empty body {}.
{
"success": true,
"data": { "sceneId": "da7a7772-...", "sceneName": "Daytime", "message": "Scene activated successfully" }
}
An unknown or unexposed scene id returns 404 with code: "SCENE_NOT_FOUND".
List groups
GET /groups — operation: monitor
{
"success": true,
"data": {
"count": 3,
"groups": [ { "id": "d426887a-...", "name": "Cafe", "type": "casambi_group", "deviceCount": 4 } ]
}
}
Control a group
POST /groups/:id/control — operation: control
Accepts the same body as device control (power/on, level/brightness, colorTemp, r+g+b), applied to every member of the group. The response reports how many devices accepted the command:
{
"success": true,
"data": { "groupId": "d426887a-...", "groupName": "Cafe", "deviceCount": 4, "succeeded": 4, "failed": 0 }
}
Parsing note
The earlier published reference described mixed scene/group results. This behavior has not been verified against the current gateway release. Inspect the returned type field (casambi_scene or casambi_group) and confirm the endpoint contract and access restrictions before using it in production.