Each service account defines access through per-scope permissions. Permissions are classified as Read or Write and determine what the integration can do with each resource. After creating a service account, open its Permissions page to define access. Use the permissions reference below to see what scopes and operations are available.
Enable only the permissions your integration requires. Granting broader access than necessary increases your security surface area.
General Basic building information such as name, address, and configuration.
Retrieve basic building information such as name, address, and configuration details.
Actions Building actions such as automated commands or system-level responses.
Retrieve building actions, such as automated commands or system-level responses.
AreasPublic Building areas such as floors, wings, or common spaces.
Retrieve building areas, such as floors, wings, or common spaces.
DatasourcesPublic Data source configurations such as BMS integrations or IoT gateways.
Retrieve data source configurations, such as BMS integrations or IoT gateways.
DevicesPublic Devices such as controllers, sensors, or actuators connected through a data source.
Retrieve device data, such as controllers, sensors, or actuators connected through a data source.
MetersPublic Meters and meter assignments for energy or utility tracking.
Retrieve every meter in the building.
Assign a meter to a resource.
Create a meter reference.
Remove a meter assignment.
Remove a meter reference.
Modify an existing meter.
PointsPublic Data points such as temperature readings, set points, or equipment status values.
Retrieve data points, such as temperature readings, set points, or equipment status values.
SpacesPublic Spaces and their meter associations within a building.
Retrieve meter data for a space.
Create multiple spaces at once.
Update multiple spaces at once.
Modify an existing space.
TenantsPublic Tenants and tenant assignments for the building.
Retrieve a single tenant.
Retrieve tenant assignments.
Modify an existing tenant.
TimeseriesPublic Time-series data for trend analysis, reporting, and energy calculations.
Retrieve time-series data for trend analysis, reporting, and energy calculations.
Write new time-series data.
WorkOrdersPublic Work orders for maintenance tasks, repair requests, and scheduled activities.
Retrieve work orders for maintenance tasks, repair requests, and scheduled activities.
