Search FloorPlanDesks - Nexudus Platform

GET

api

sys

floorplandesks

Search FloorPlanDesks

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/floorplandesks \
  --header 'Authorization: Basic <encoded-value>'

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

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 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

Link a unit to a 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

Value	Name
1	Office
2	DedicatedDesk
3	HotDesk
4	Other
5	Room

eCoworkerRecordType

Value	Name
1	Individual
2	Company

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

page

integer

default:"1"

The page number to retrieve.

size

integer

default:"25"

The number of records per page.

orderBy

string

The property name to sort results by (e.g. Name, CreatedOn).

dir

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

FloorPlanDesk_FloorPlan

integer

Filter by iD of the floor plan this unit belongs to.

FloorPlanDesk_FloorPlan_Name

string

Filter by floor plan name.

FloorPlanDesk_FloorPlan_Business_Id

integer

Filter by iD of the location that owns the floor plan.

FloorPlanDesk_FloorPlan_Business_Currency_Code

string

Filter by currency code of the location.

FloorPlanDesk_FloorPlan_Business_Name

string

Filter by location name.

FloorPlanDesk_FloorPlan_Capacity

integer

Filter by maximum capacity of the floor plan.

FloorPlanDesk_Coworker

integer

Filter by iD of the customer assigned to this unit (used for dedicated desks and offices).

FloorPlanDesk_Coworker_FullName

string

Filter by full name of the assigned customer.

FloorPlanDesk_Coworker_CompanyName

string

Filter by company name of the assigned customer.

FloorPlanDesk_Coworker_CoworkerType

string

Filter by record type of the assigned customer (Individual or Company).

FloorPlanDesk_Coworker_Email

string

Filter by email address of the assigned customer.

FloorPlanDesk_Coworker_TeamNames

string

Filter by names of the teams the assigned customer belongs to.

FloorPlanDesk_Sensor

integer

Filter by iD of the IoT sensor monitoring occupancy or environmental conditions in this unit.

FloorPlanDesk_Sensor_Name

string

Filter by sensor name.

FloorPlanDesk_Sensor_Unit

string

Filter by unit of measurement reported by the sensor (e.g. °C, ppm).

FloorPlanDesk_Sensor_SensorType

string

Filter by type of the linked sensor (e.g. PresenceDetection, PeopleCounter, Temperature).

FloorPlanDesk_Sensor_LastReceivedValue

string

Filter by most recent raw value reported by the sensor.

FloorPlanDesk_Sensor_LastValueTriggeredAction

boolean

Filter by whether the last sensor reading triggered a configured automation action.

FloorPlanDesk_Name

string

Filter by display name of the floor plan unit (e.g. ‘Office 3’, ‘Hot Desk 12’).

FloorPlanDesk_ItemType

integer

Filter by type of area this unit represents: Office, DedicatedDesk, HotDesk, Room, or Other.

FloorPlanDesk_Resource

integer

Filter by iD of the bookable resource linked to this unit, enabling customers to book it via the floor plan view.

FloorPlanDesk_Resource_Name

string

Filter by linked resource name.

FloorPlanDesk_Resource_ResourceType_Name

string

Filter by resource type name of the linked resource.

FloorPlanDesk_Resource_Allocation

integer

Filter by maximum simultaneous bookings allowed for the linked resource.

FloorPlanDesk_Resource_Projector

boolean

Filter by whether the linked resource has a projector.

FloorPlanDesk_Resource_Internet

boolean

Filter by whether the linked resource provides internet access.

FloorPlanDesk_Resource_ConferencePhone

boolean

Filter by whether the linked resource has a conference phone.

FloorPlanDesk_Resource_StandardPhone

boolean

Filter by whether the linked resource has a standard phone.

FloorPlanDesk_Resource_WhiteBoard

boolean

Filter by whether the linked resource has a whiteboard.

FloorPlanDesk_Resource_LargeDisplay

boolean

Filter by whether the linked resource has a large display or TV screen.

FloorPlanDesk_Resource_Catering

boolean

Filter by whether the linked resource offers catering services.

FloorPlanDesk_Resource_TeaAndCoffee

boolean

Filter by whether the linked resource provides tea and coffee.

FloorPlanDesk_Resource_Drinks

boolean

Filter by whether the linked resource provides drinks.

FloorPlanDesk_Resource_SecurityLock

boolean

Filter by whether the linked resource has a security lock.

FloorPlanDesk_Resource_CCTV

boolean

Filter by whether the linked resource is covered by CCTV.

FloorPlanDesk_Resource_VoiceRecorder

boolean

Filter by whether the linked resource has a voice recorder.

FloorPlanDesk_Resource_AirConditioning

boolean

Filter by whether the linked resource has air conditioning.

FloorPlanDesk_Resource_Heating

boolean

Filter by whether the linked resource has heating.

FloorPlanDesk_Resource_NaturalLight

boolean

Filter by whether the linked resource has natural light.

FloorPlanDesk_Resource_StandingDesk

boolean

Filter by whether the linked resource has a standing desk.

FloorPlanDesk_Resource_QuietZone

boolean

Filter by whether the linked resource is in a quiet zone.

FloorPlanDesk_Resource_WirelessCharger

boolean

Filter by whether the linked resource has a wireless charger.

FloorPlanDesk_Resource_PrivacyScreen

boolean

Filter by whether the linked resource has a privacy screen.

FloorPlanDesk_Resource_Soundproof

boolean

Filter by whether the linked resource is soundproofed.

FloorPlanDesk_Resource_Shifts

string

Filter by shift schedule defined on the linked resource.

FloorPlanDesk_Size

number

Filter by floor area of this unit (e.g. in sq ft or sq m, depending on the location’s unit setting).

FloorPlanDesk_SizeIsLinkedToArea

boolean

Filter by when true, the Size value is automatically calculated from the drawn shape area on the floor plan canvas.

FloorPlanDesk_Capacity

number

Filter by number of people this unit can accommodate at the same time.

FloorPlanDesk_Price

number

Filter by indicative price displayed on the floor plan view (informational only; actual billing is handled by products and contracts).

FloorPlanDesk_Area

string

Filter by computed area of the drawn shape on the floor plan canvas, set automatically by the editor.

FloorPlanDesk_SensorLastValue

string

Filter by formatted display value of the last reading from the linked sensor.

FloorPlanDesk_IsSensorOccupied

boolean

Filter by whether the linked sensor currently indicates this unit is occupied.

FloorPlanDesk_Notes

string

Filter by internal notes about this unit, visible to admins only.

FloorPlanDesk_Available

boolean

Filter by whether this unit is currently available for assignment or booking.

FloorPlanDesk_AvailableToAi

boolean

Filter by whether this unit is available to any AI channels (Email, Chat or WhatsApp) for recommendations for private offices;.

FloorPlanDesk_NotesForAi

string

Filter by notes or instructions for AI channels to consider when recommending this unit for private offices (e.g. ‘great natural light but a bit noisy’).

FloorPlanDesk_ShowPriceForAi

boolean

Filter by whether to show the price of this unit in AI channel recommendations and responses based on users’ budget preferences.

FloorPlanDesk_PriceForAi

number

Filter by override price to show in AI channel recommendations and responses based on users’ budget preferences (if not set, the regular Price value is used).

FloorPlanDesk_PositionX

integer

Filter by x coordinate of this unit’s position on the floor plan canvas.

FloorPlanDesk_PositionY

integer

Filter by y coordinate of this unit’s position on the floor plan canvas.

FloorPlanDesk_PositionZ

integer

Filter by z-index (draw order) of this unit on the floor plan canvas; higher values render on top.

FloorPlanDesk_AccessControlGroupId

string

Filter by access control group identifier that governs door/entry access for this unit.

FloorPlanDesk_TunnelPrivateGroupId

string

Filter by network tunnel group identifier for private network access scoped to this unit.

FloorPlanDesk_CoworkerContractIds

string

Filter by comma-separated list of contract IDs currently assigned to this unit.

FloorPlanDesk_CoworkerContractFullNames

string

Filter by comma-separated list of customer names from contracts assigned to this unit.

FloorPlanDesk_CoworkerContractStartDates

string

Filter by comma-separated list of start dates for contracts assigned to this unit.

FloorPlanDesk_AvailableFromTime

string

Filter by uTC date/time from which this unit becomes available.

FloorPlanDesk_AvailableToTime

string

Filter by uTC date/time until which this unit is available.

FloorPlanDesk_AvailableFromTimeLocal

string

Filter by local date/time from which this unit becomes available (derived from AvailableFromTime).

FloorPlanDesk_AvailableToTimeLocal

string

Filter by local date/time until which this unit is available (derived from AvailableToTime).

FloorPlanDesk_ArchilogicUniqueId

string

Filter by unique identifier linking this unit to its corresponding element in an Archilogic 3D model.

FloorPlanDesk_FloorPlanLayoutAssetUniqueId

string

Filter by unique identifier linking this unit to a component in the associated floor plan layout template.

Range Filters

from_FloorPlanDesk_FloorPlanBusinessId

integer

Filter by iD of the location that owns the floor plan greater than or equal to this value.

to_FloorPlanDesk_FloorPlanBusinessId

integer

Filter by iD of the location that owns the floor plan less than or equal to this value.

from_FloorPlanDesk_FloorPlanCapacity

integer

Filter by maximum capacity of the floor plan greater than or equal to this value.

to_FloorPlanDesk_FloorPlanCapacity

integer

Filter by maximum capacity of the floor plan less than or equal to this value.

from_FloorPlanDesk_ResourceAllocation

integer

Filter by maximum simultaneous bookings allowed for the linked resource greater than or equal to this value.

to_FloorPlanDesk_ResourceAllocation

integer

Filter by maximum simultaneous bookings allowed for the linked resource less than or equal to this value.

from_FloorPlanDesk_Size

number

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.

to_FloorPlanDesk_Size

number

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.

from_FloorPlanDesk_Capacity

number

Filter by number of people this unit can accommodate at the same time greater than or equal to this value.

to_FloorPlanDesk_Capacity

number

Filter by number of people this unit can accommodate at the same time less than or equal to this value.

from_FloorPlanDesk_Price

number

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.

to_FloorPlanDesk_Price

number

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.

from_FloorPlanDesk_PriceForAi

number

Filter by override price to show in AI channel recommendations and responses based on users’ budget preferences (if not set, the regular Price value is used) greater than or equal to this value.

to_FloorPlanDesk_PriceForAi

number

Filter by override price to show in AI channel recommendations and responses based on users’ budget preferences (if not set, the regular Price value is used) less than or equal to this value.

from_FloorPlanDesk_PositionX

integer

Filter by x coordinate of this unit’s position on the floor plan canvas greater than or equal to this value.

to_FloorPlanDesk_PositionX

integer

Filter by x coordinate of this unit’s position on the floor plan canvas less than or equal to this value.

from_FloorPlanDesk_PositionY

integer

Filter by y coordinate of this unit’s position on the floor plan canvas greater than or equal to this value.

to_FloorPlanDesk_PositionY

integer

Filter by y coordinate of this unit’s position on the floor plan canvas less than or equal to this value.

from_FloorPlanDesk_PositionZ

integer

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.

to_FloorPlanDesk_PositionZ

integer

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.

from_FloorPlanDesk_AvailableFromTime

string

Filter by uTC date/time from which this unit becomes available greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_FloorPlanDesk_AvailableFromTime

string

Filter by uTC date/time from which this unit becomes available less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_FloorPlanDesk_AvailableToTime

string

Filter by uTC date/time until which this unit is available greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_FloorPlanDesk_AvailableToTime

string

Filter by uTC date/time until which this unit is available less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_FloorPlanDesk_AvailableFromTimeLocal

string

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.

to_FloorPlanDesk_AvailableFromTimeLocal

string

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.

from_FloorPlanDesk_AvailableToTimeLocal

string

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.

to_FloorPlanDesk_AvailableToTimeLocal

string

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.

from_FloorPlanDesk_CreatedOn

string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

to_FloorPlanDesk_CreatedOn

string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

from_FloorPlanDesk_UpdatedOn

string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

to_FloorPlanDesk_UpdatedOn

string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/sys/floorplandesks?page=1&size=15&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Filtering by Name

curl -X GET \
  "https://spaces.nexudus.com/api/sys/floorplandesks?FloorPlanDesk_Name=example-value&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/sys/floorplandesks?from_FloorPlanDesk_UpdatedOn=2025-01-01T00:00&to_FloorPlanDesk_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

200

Records

FloorPlanDesk[]

The list of FloorPlanDesk records matching the query. See the Get one FloorPlanDesk endpoint for the full list of properties returned for each record.

Partial records — The listing endpoint returns a summary representation of each FloorPlanDesk. The following fields are not populated in the Records[] response: Notes.To get all fields, fetch the full record using the Get one FloorPlanDesk endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.

CurrentPage

integer

Current page number.

CurrentPageSize

integer

Number of records per page.

CurrentOrderField

string

The field used for sorting.

CurrentSortDirection

integer

The sort direction (0 = ascending, 1 = descending).

FirstItem

integer

Index of the first item on the current page.

LastItem

integer

Index of the last item on the current page.

TotalItems

integer

Total number of matching records across all pages.

TotalPages

integer

Total number of pages.

HasNextPage

boolean

Whether there is a next page of results.

HasPreviousPage

boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "FloorPlanId": 0,
      "FloorPlanName": null,
      "FloorPlanBusinessId": null,
      "FloorPlanBusinessCurrencyCode": null,
      "FloorPlanBusinessName": null,
      "FloorPlanCapacity": null,
      "CoworkerId": null,
      "CoworkerFullName": null,
      "CoworkerCompanyName": null,
      "CoworkerCoworkerType": null,
      "CoworkerEmail": null,
      "CoworkerTeamNames": null,
      "SensorId": null,
      "SensorName": null,
      "SensorUnit": null,
      "SensorSensorType": null,
      "SensorLastReceivedValue": null,
      "SensorLastValueTriggeredAction": null,
      "Name": "",
      "ItemType": 0,
      "ResourceId": null,
      "ResourceName": null,
      "ResourceResourceTypeName": null,
      "ResourceAllocation": null,
      "ResourceProjector": null,
      "ResourceInternet": null,
      "ResourceConferencePhone": null,
      "ResourceStandardPhone": null,
      "ResourceWhiteBoard": null,
      "ResourceLargeDisplay": null,
      "ResourceCatering": null,
      "ResourceTeaAndCoffee": null,
      "ResourceDrinks": null,
      "ResourceSecurityLock": null,
      "ResourceCCTV": null,
      "ResourceVoiceRecorder": null,
      "ResourceAirConditioning": null,
      "ResourceHeating": null,
      "ResourceNaturalLight": null,
      "ResourceStandingDesk": null,
      "ResourceQuietZone": null,
      "ResourceWirelessCharger": null,
      "ResourcePrivacyScreen": null,
      "ResourceSoundproof": null,
      "ResourceShifts": null,
      "Size": 0,
      "SizeIsLinkedToArea": false,
      "Capacity": 0,
      "Price": 0,
      "Area": null,
      "SensorLastValue": null,
      "IsSensorOccupied": false,
      "Available": false,
      "AvailableToAi": false,
      "NotesForAi": null,
      "ShowPriceForAi": false,
      "PriceForAi": null,
      "PositionX": 0,
      "PositionY": 0,
      "PositionZ": 0,
      "AccessControlGroupId": null,
      "TunnelPrivateGroupId": null,
      "CoworkerContractIds": null,
      "CoworkerContractFullNames": null,
      "CoworkerContractStartDates": null,
      "AvailableFromTime": null,
      "AvailableToTime": null,
      "AvailableFromTimeLocal": null,
      "AvailableToTimeLocal": null,
      "ArchilogicUniqueId": null,
      "FloorPlanLayoutAssetUniqueId": null,
      "Id": 87654321,
      "UpdatedOn": "2025-01-15T10:30:00Z",
      "CreatedOn": "2025-01-10T08:00:00Z",
      "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "UpdatedBy": "admin@example.com",
      "IsNew": false,
      "SystemId": null,
      "ToStringText": "FloorPlanDesk Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Get one FloorPlanDeskRetrieve a single FloorPlanDesk record by its Id.

Search FloorPlanDesks

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/floorplandesks \
  --header 'Authorization: Basic <encoded-value>'

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

​Authentication

​Enums

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by Name

​Range filters

​Response

​200

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200