Areas

An area (server name: sublocation) is a physical sub-region inside a Site. Areas contain Floorplans, placed Anchors, and Zones.

Quick reference

Method	What it does
client.areas.list()	All areas visible to the current scope.
client.areas.create(name, *, location_uid, **fields)	Create an area inside location_uid (the parent site).
client.areas.update(uid, **fields)	Update; free-form fields.
client.areas.delete(uid)	Delete; cascades server-side to floorplans, anchors, zones.

Reading and writing

areas = client.areas.list()
area = client.areas.create(name="Bay 3", location_uid=site.uid)
client.areas.update(area.uid, description="freezer", position_x=10.0)
client.areas.delete(area.uid)

update does not enforce an allowlist — the desktop site-plan client sends arbitrary placement fields (position_x, position_y, width, height, rotation) freely. The SDK passes them through.

Model — Area

Field	Type	Notes
uid	str	Server-assigned.
name	str \| None	Display name.
location_uid	str \| None	Parent site uid.
description	str \| None	Free-form.
position_x / position_y	float \| None	Origin on the parent site.
width / height	float \| None	Dimensions.
rotation	float \| None	Degrees.

Full field list.

Related entities

• Parent: Sites. client.areas.create(location_uid=site.uid).
• Children: Floorplans, Anchors, Zones.
• Alarms: client.alarms.list_for_area(uid=...).

See also

• Sites — the parent and the cascade contract.