FloorPlanDesks
Search FloorPlanDesks
Search and list FloorPlanDesk records with filtering, sorting, and pagination.
GET
Search FloorPlanDesks
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-List role.Enums
eFloorPlanItemType — ItemType values
eFloorPlanItemType — ItemType values
| Value | Name |
|---|---|
| 1 | Office |
| 2 | DedicatedDesk |
| 3 | HotDesk |
| 4 | Other |
| 5 | Room |
eCoworkerRecordType
eCoworkerRecordType
| Value | Name |
|---|---|
| 1 | Individual |
| 2 | Company |
eSensorType
eSensorType
| Value | Name |
|---|---|
| 1 | PresenceDetection |
| 2 | PeopleCounter |
| 3 | Temperature |
| 4 | Humidity |
| 5 | Light |
| 6 | Noise |
| 7 | CO2 |
| 8 | VolatileOrganicCompounds |
| 9 | HarmfulParticulates |
| 10 | Touch |
| 11 | Water |
| 12 | AtmosphericPressure |
| 13 | Power |
| 14 | OpenClosed |
| 99 | Other |
Query Parameters
Pagination & Sorting
The page number to retrieve.
The number of records per page.
The property name to sort results by (e.g.
Name, CreatedOn).Sort direction.
1 for ascending, -1 for descending.Filters
Filter by iD of the floor plan this unit belongs to.
Filter by floor plan name.
Filter by iD of the location that owns the floor plan.
Filter by currency code of the location.
Filter by location name.
Filter by maximum capacity of the floor plan.
Filter by iD of the customer assigned to this unit (used for dedicated desks and offices).
Filter by full name of the assigned customer.
Filter by company name of the assigned customer.
Filter by record type of the assigned customer (Individual or Company).
Filter by email address of the assigned customer.
Filter by names of the teams the assigned customer belongs to.
Filter by iD of the IoT sensor monitoring occupancy or environmental conditions in this unit.
Filter by sensor name.
Filter by unit of measurement reported by the sensor (e.g. °C, ppm).
Filter by type of the linked sensor (e.g. PresenceDetection, PeopleCounter, Temperature).
Filter by most recent raw value reported by the sensor.
Filter by whether the last sensor reading triggered a configured automation action.
Filter by display name of the floor plan unit (e.g. ‘Office 3’, ‘Hot Desk 12’).
Filter by type of area this unit represents: Office, DedicatedDesk, HotDesk, Room, or Other.
Filter by iD of the bookable resource linked to this unit, enabling customers to book it via the floor plan view.
Filter by linked resource name.
Filter by resource type name of the linked resource.
Filter by maximum simultaneous bookings allowed for the linked resource.
Filter by whether the linked resource has a projector.
Filter by whether the linked resource provides internet access.
Filter by whether the linked resource has a conference phone.
Filter by whether the linked resource has a standard phone.
Filter by whether the linked resource has a whiteboard.
Filter by whether the linked resource has a large display or TV screen.
Filter by whether the linked resource offers catering services.
Filter by whether the linked resource provides tea and coffee.
Filter by whether the linked resource provides drinks.
Filter by whether the linked resource has a security lock.
Filter by whether the linked resource is covered by CCTV.
Filter by whether the linked resource has a voice recorder.
Filter by whether the linked resource has air conditioning.
Filter by whether the linked resource has heating.
Filter by whether the linked resource has natural light.
Filter by whether the linked resource has a standing desk.
Filter by whether the linked resource is in a quiet zone.
Filter by whether the linked resource has a wireless charger.
Filter by whether the linked resource has a privacy screen.
Filter by whether the linked resource is soundproofed.
Filter by shift schedule defined on the linked resource.
Filter by floor area of this unit (e.g. in sq ft or sq m, depending on the location’s unit setting).
Filter by when true, the Size value is automatically calculated from the drawn shape area on the floor plan canvas.
Filter by number of people this unit can accommodate at the same time.
Filter by indicative price displayed on the floor plan view (informational only; actual billing is handled by products and contracts).
Filter by computed area of the drawn shape on the floor plan canvas, set automatically by the editor.
Filter by formatted display value of the last reading from the linked sensor.
Filter by whether the linked sensor currently indicates this unit is occupied.
Filter by internal notes about this unit, visible to admins only.
Filter by whether this unit is currently available for assignment or booking.
Filter by x coordinate of this unit’s position on the floor plan canvas.
Filter by y coordinate of this unit’s position on the floor plan canvas.
Filter by z-index (draw order) of this unit on the floor plan canvas; higher values render on top.
Filter by access control group identifier that governs door/entry access for this unit.
Filter by network tunnel group identifier for private network access scoped to this unit.
Filter by comma-separated list of contract IDs currently assigned to this unit.
Filter by comma-separated list of customer names from contracts assigned to this unit.
Filter by comma-separated list of start dates for contracts assigned to this unit.
Filter by uTC date/time from which this unit becomes available.
Filter by uTC date/time until which this unit is available.
Filter by local date/time from which this unit becomes available (derived from AvailableFromTime).
Filter by local date/time until which this unit is available (derived from AvailableToTime).
Filter by unique identifier linking this unit to its corresponding element in an Archilogic 3D model.
Filter by unique identifier linking this unit to a component in the associated floor plan layout template.
Range Filters
Filter by iD of the location that owns the floor plan greater than or equal to this value.
Filter by iD of the location that owns the floor plan less than or equal to this value.
Filter by maximum capacity of the floor plan greater than or equal to this value.
Filter by maximum capacity of the floor plan less than or equal to this value.
Filter by maximum simultaneous bookings allowed for the linked resource greater than or equal to this value.
Filter by maximum simultaneous bookings allowed for the linked resource less than or equal to this value.
Filter by floor area of this unit (e.g. in sq ft or sq m, depending on the location’s unit setting) greater than or equal to this value.
Filter by floor area of this unit (e.g. in sq ft or sq m, depending on the location’s unit setting) less than or equal to this value.
Filter by number of people this unit can accommodate at the same time greater than or equal to this value.
Filter by number of people this unit can accommodate at the same time less than or equal to this value.
Filter by indicative price displayed on the floor plan view (informational only; actual billing is handled by products and contracts) greater than or equal to this value.
Filter by indicative price displayed on the floor plan view (informational only; actual billing is handled by products and contracts) less than or equal to this value.
Filter by x coordinate of this unit’s position on the floor plan canvas greater than or equal to this value.
Filter by x coordinate of this unit’s position on the floor plan canvas less than or equal to this value.
Filter by y coordinate of this unit’s position on the floor plan canvas greater than or equal to this value.
Filter by y coordinate of this unit’s position on the floor plan canvas less than or equal to this value.
Filter by z-index (draw order) of this unit on the floor plan canvas; higher values render on top greater than or equal to this value.
Filter by z-index (draw order) of this unit on the floor plan canvas; higher values render on top less than or equal to this value.
Filter by uTC date/time from which this unit becomes available greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by uTC date/time from which this unit becomes available less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by uTC date/time until which this unit is available greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by uTC date/time until which this unit is available less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by local date/time from which this unit becomes available (derived from AvailableFromTime) greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by local date/time from which this unit becomes available (derived from AvailableFromTime) less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by local date/time until which this unit is available (derived from AvailableToTime) greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter by local date/time until which this unit is available (derived from AvailableToTime) less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.Filter records created on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records created on or before this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or after this date. Format:
YYYY-MM-DDTHH:mm.Filter records updated on or before this date. Format:
YYYY-MM-DDTHH:mm.Code Examples
Simple listing
Filtering by Name
Range filters
Response
200
The list of FloorPlanDesk records matching the query. See the Get one FloorPlanDesk endpoint for the full list of properties returned for each record.
Current page number.
Number of records per page.
The field used for sorting.
The sort direction (
1 = ascending, -1 = descending).Index of the first item on the current page.
Index of the last item on the current page.
Total number of matching records across all pages.
Total number of pages.
Whether there is a next page of results.
Whether there is a previous page of results.
Example Response
Search FloorPlanDesks