FloorPlanDesks
Get one FloorPlanDesk
Retrieve a single FloorPlanDesk record by its Id.
GET
Get one FloorPlanDesk
A FloorPlanDesk (referred to as a floor plan unit in the UI) represents a specific area or room placed on a floor plan. Each unit typically maps to a bookable resource or a space assigned to a customer through a contract.
There are five unit types controlled by
Link a unit to a
ItemType:
| ItemType | Typical use |
|---|---|
| Office | Private office assigned to a customer via a contract |
| DedicatedDesk | Desk permanently assigned to a customer via a contract |
| HotDesk | Shared desk bookable via a resource or assigned to a contract |
| Room | Meeting room or bookable space linked to a resource |
| Other | Any area that does not match the types above |
Resource via ResourceId to let customers book it through the floor plan view on the Members Portal. Assign it to one or more contracts via CoworkerContractIds to track occupancy.
Units can be monitored by an IoT sensor (SensorId). The last sensor reading is exposed via SensorLastValue and IsSensorOccupied.
Position and size on the canvas are maintained by the floor plan editor. AvailableFromTime / AvailableToTime allow time-bounded availability windows.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the FloorPlanDesk-Read role.Path Parameters
The Id of the FloorPlanDesk record to retrieve.
Code Examples
Response
200
ID of the floor plan this unit belongs to.
Floor plan name.
ID of the location that owns the floor plan.
Currency code of the location.
Location name.
Maximum capacity of the floor plan.
ID of the customer assigned to this unit (used for dedicated desks and offices).
Full name of the assigned customer.
Company name of the assigned customer.
Record type of the assigned customer (Individual or Company).
Email address of the assigned customer.
Names of the teams the assigned customer belongs to.
ID of the IoT sensor monitoring occupancy or environmental conditions in this unit.
Sensor name.
Unit of measurement reported by the sensor (e.g. °C, ppm).
Type of the linked sensor (e.g. PresenceDetection, PeopleCounter, Temperature).
Most recent raw value reported by the sensor.
Whether the last sensor reading triggered a configured automation action.
Display name of the floor plan unit (e.g. ‘Office 3’, ‘Hot Desk 12’).
Type of area this unit represents: Office, DedicatedDesk, HotDesk, Room, or Other. See
eFloorPlanItemType enum values: 1 = Office, 2 = DedicatedDesk, 3 = HotDesk, 4 = Other, 5 = Room.ID of the bookable resource linked to this unit, enabling customers to book it via the floor plan view.
Linked resource name.
Resource type name of the linked resource.
Maximum simultaneous bookings allowed for the linked resource.
Whether the linked resource has a projector.
Whether the linked resource provides internet access.
Whether the linked resource has a conference phone.
Whether the linked resource has a standard phone.
Whether the linked resource has a whiteboard.
Whether the linked resource has a large display or TV screen.
Whether the linked resource offers catering services.
Whether the linked resource provides tea and coffee.
Whether the linked resource provides drinks.
Whether the linked resource has a security lock.
Whether the linked resource is covered by CCTV.
Whether the linked resource has a voice recorder.
Whether the linked resource has air conditioning.
Whether the linked resource has heating.
Whether the linked resource has natural light.
Whether the linked resource has a standing desk.
Whether the linked resource is in a quiet zone.
Whether the linked resource has a wireless charger.
Whether the linked resource has a privacy screen.
Whether the linked resource is soundproofed.
Shift schedule defined on the linked resource.
Floor area of this unit (e.g. in sq ft or sq m, depending on the location’s unit setting).
When true, the Size value is automatically calculated from the drawn shape area on the floor plan canvas.
Number of people this unit can accommodate at the same time.
Indicative price displayed on the floor plan view (informational only; actual billing is handled by products and contracts).
Computed area of the drawn shape on the floor plan canvas, set automatically by the editor.
Formatted display value of the last reading from the linked sensor.
Whether the linked sensor currently indicates this unit is occupied.
Internal notes about this unit, visible to admins only.
Whether this unit is currently available for assignment or booking.
X coordinate of this unit’s position on the floor plan canvas.
Y coordinate of this unit’s position on the floor plan canvas.
Z-index (draw order) of this unit on the floor plan canvas; higher values render on top.
Access control group identifier that governs door/entry access for this unit.
Network tunnel group identifier for private network access scoped to this unit.
Comma-separated list of contract IDs currently assigned to this unit.
Comma-separated list of customer names from contracts assigned to this unit.
Comma-separated list of start dates for contracts assigned to this unit.
UTC date/time from which this unit becomes available.
UTC date/time until which this unit is available.
Local date/time from which this unit becomes available (derived from AvailableFromTime).
Local date/time until which this unit is available (derived from AvailableToTime).
Unique identifier linking this unit to its corresponding element in an Archilogic 3D model.
Unique identifier linking this unit to a component in the associated floor plan layout template.
Unique record identifier.
UUID of the record.
Date and time the record was created (ISO 8601).
Date and time the record was last updated (ISO 8601).
Email of the user who last updated this record.
Whether the record was recently created.
External system identifier.
Example Response
Get one FloorPlanDesk