Loading...
Endpoints
The full REST surface, generated from the OpenAPI description.
All paths are relative to https://api.circuvent.com. Responses are JSON. GET /v1 returns this same list machine-readably, and an OpenAPI 3.1 document is published if you would rather generate a client.
Discovery
Index and credential introspection.
| Method | Path | Scope | Description |
|---|---|---|---|
| GET | /v1 | — | API index |
| GET | /v1/me | devices:read | Identify this credential |
Devices
Read state and send commands.
| Method | Path | Scope | Description |
|---|---|---|---|
| GET | /v1/devices | devices:read | List devices |
| GET | /v1/devices/{id} | devices:read | Get one device |
| PATCH | /v1/devices/{id} | devices:write | Rename, assign a room, or set favourite |
| POST | /v1/devices/{id}/commands | devices:control | Send a command |
Telemetry
Historical series.
| Method | Path | Scope | Description |
|---|---|---|---|
| GET | /v1/devices/{id}/energy | telemetry:read | Bucketed energy series |
| GET | /v1/devices/{id}/telemetry | telemetry:read | Telemetry history |
Organisation
Rooms, scenes, automations and events.
| Method | Path | Scope | Description |
|---|---|---|---|
| GET | /v1/automations | automations:read | List automation rules |
| POST | /v1/automations | automations:write | Create an automation rule |
| DELETE | /v1/automations/{id} | automations:write | Delete a rule |
| PATCH | /v1/automations/{id} | automations:write | Update or enable/disable a rule |
| GET | /v1/events | events:read | Event and activity feed |
| GET | /v1/rooms | rooms:read | List rooms |
| GET | /v1/scenes | scenes:read | List scenes |
| POST | /v1/scenes/{id}/activate | scenes:run | Run a scene |
ANPR
Number-plate reads, the vehicle register and site occupancy. Scoped separately from telemetry: a plate log is a record of which vehicles came to a property, about people who are not the account holder.
| Method | Path | Scope | Description |
|---|---|---|---|
| GET | /v1/occupancy | plates:read | How full the site is right now |
| GET | /v1/plate-rules | plates:read | The allow / deny / watch list |
| POST | /v1/plate-rules | plates:write | Put a plate on a list |
| DELETE | /v1/plate-rules/{id} | plates:write | Remove a plate from its list |
| GET | /v1/plates | plates:read | Number-plate reads |
| GET | /v1/plates/{id}/image | plates:read | The capture a plate was read from |
| GET | /v1/vehicles | plates:read | The vehicle register |
| GET | /v1/vehicles/{plate} | plates:read | One vehicle's visit history |
GET /v1/devices
{
"devices": [
{
"id": "hub-a1b2",
"name": "Living room hub",
"type": "home-hub",
"room": "Living Room",
"favorite": true,
"online": true,
"lastSeen": "2026-08-03T09:12:44.201Z",
"firmware": "1.4.2",
"state": { "power": true, "power2": false, "power3": false, "power4": false }
}
]
}