Spaces

Spaces attach room/zone-level attributes to a location: usage type, capacity, status, area_sqft, and optional attributes (e.g. amenities, BMS zone id). One space per location (typically a location with location_type room or zone). Work orders continue to reference location_id; join to spaces when you need usage or status. Set tenant context before calling these methods.

List spaces

List all spaces for the current tenant (from v_spaces). Rows include location_name, location_type.

const spaces = await client.spaces.list()
// Returns SpaceRow[]

Get by ID

Fetch a single space by ID.

const space = await client.spaces.getById('uuid-of-space')
// Returns SpaceRow | null

Get by location

Fetch the space for a given location (at most one space per location).

const space = await client.spaces.getByLocationId('uuid-of-location')
// Returns SpaceRow | null

Create space

Create a space for a location. Returns the new space UUID.

const spaceId = await client.spaces.create({
  tenantId: 'uuid-of-tenant',
  locationId: 'uuid-of-location',
  usageType: 'office',
  capacity: 4,
  status: 'available',
  areaSqft: 120.5,
  attributes: null,
})
// Returns string (UUID)

Update space

Update an existing space. All fields except tenantId and spaceId are optional.

await client.spaces.update({
  tenantId: 'uuid-of-tenant',
  spaceId: 'uuid-of-space',
  status: 'occupied',
})

Delete space

Delete a space by tenant and space ID.

await client.spaces.delete('uuid-of-tenant', 'uuid-of-space')