HomeOS
ArchitectureSign in
Back
API · v1 · Production-ready

API Reference

Versioned REST API at https://api.homeos.gr/v1. Authenticate with bearer tokens scoped per portfolio.

Base URL
api.homeos.gr/v1
Auth
Bearer <token>
Rate limit
1000 req / min

Endpoints

GET
/v1/propertiesList all properties in the portfolio
POST
/v1/propertiesCreate a new property
GET
/v1/properties/{id}Retrieve a property with its hierarchy
PATCH
/v1/properties/{id}Update property metadata
DELETE
/v1/properties/{id}Archive a property
GET
/v1/devicesSearch devices across the portfolio
POST
/v1/devices/{id}/commandSend a command to a device
GET
/v1/devices/{id}/stateGet the current device state
POST
/v1/scenes/{id}/activateTrigger a scene
POST
/v1/ticketsCreate a maintenance ticket
POST
/v1/webhooks/haInbound Home Assistant webhook
Example request
curl -X POST https://api.homeos.gr/v1/devices/d-1/command \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "type": "set_state", "state": { "on": true, "brightness": 70 } }'
Example response
{
  "id": "d-1",
  "name": "Bedside Lamp",
  "online": true,
  "state": { "on": true, "brightness": 70 },
  "updatedAt": "2026-05-19T10:24:11Z"
}