Homes API
Use the homes endpoints to organize devices into homes and rooms for tenant-aware automation flows.
Base URL: https://api.hestialabs.in/v1
Endpointsâ
| Method | Path | Summary |
|---|---|---|
GET | /homes | List Homes |
GET | /homes/{homeId}/rooms | List Rooms |
POST | /homes | Create Home |
POST | /homes/{homeId}/rooms | Create Room |
List Homesâ
GET /homes
List all homes for the tenant
Authentication: Bearer JWT required
Parametersâ
None.
Responsesâ
| Status | Description |
|---|---|
200 | Home list |
Example 200 responseâ
{
"homes": [
"value"
]
}
List Roomsâ
GET /homes/{homeId}/rooms
List rooms in a home
Authentication: Bearer JWT required
Parametersâ
| Name | In | Type | Required | Description |
|---|---|---|---|---|
homeId | path | string | Yes | â |
Responsesâ
| Status | Description |
|---|---|
200 | Room list |
Create Homeâ
POST /homes
Create a new home
Authentication: Bearer JWT required
Parametersâ
None.
Request bodyâ
| Field | Type | Required | Description |
|---|---|---|---|
home_name | string | Yes | â |
timezone | string | No | â |
Example requestâ
{
"home_name": "string",
"timezone": "string"
}
Responsesâ
| Status | Description |
|---|---|
201 | Home created |
Create Roomâ
POST /homes/{homeId}/rooms
Create a room in a home
Authentication: Bearer JWT required
Parametersâ
| Name | In | Type | Required | Description |
|---|---|---|---|---|
homeId | path | string | Yes | â |
Request bodyâ
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | â |
Example requestâ
{
"name": "string"
}
Responsesâ
| Status | Description |
|---|---|
201 | Room created |