Get one FloorPlanDesk

GET

api

sys

floorplandesks

{id}

Get one FloorPlanDesk

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

import requests

url = "https://spaces.nexudus.com/api/sys/floorplandesks/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/floorplandesks/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "FloorPlanId": 123,
  "FloorPlanName": "<string>",
  "FloorPlanBusinessId": 123,
  "FloorPlanBusinessCurrencyCode": "<string>",
  "FloorPlanBusinessName": "<string>",
  "FloorPlanCapacity": 123,
  "CoworkerId": 123,
  "CoworkerFullName": "<string>",
  "CoworkerCompanyName": "<string>",
  "CoworkerCoworkerType": "<string>",
  "CoworkerEmail": "<string>",
  "CoworkerTeamNames": "<string>",
  "SensorId": 123,
  "SensorName": "<string>",
  "SensorUnit": "<string>",
  "SensorSensorType": "<string>",
  "SensorLastReceivedValue": "<string>",
  "SensorLastValueTriggeredAction": true,
  "Name": "<string>",
  "ItemType": 123,
  "ResourceId": 123,
  "ResourceName": "<string>",
  "ResourceResourceTypeName": "<string>",
  "ResourceAllocation": 123,
  "ResourceProjector": true,
  "ResourceInternet": true,
  "ResourceConferencePhone": true,
  "ResourceStandardPhone": true,
  "ResourceWhiteBoard": true,
  "ResourceLargeDisplay": true,
  "ResourceCatering": true,
  "ResourceTeaAndCoffee": true,
  "ResourceDrinks": true,
  "ResourceSecurityLock": true,
  "ResourceCCTV": true,
  "ResourceVoiceRecorder": true,
  "ResourceAirConditioning": true,
  "ResourceHeating": true,
  "ResourceNaturalLight": true,
  "ResourceStandingDesk": true,
  "ResourceQuietZone": true,
  "ResourceWirelessCharger": true,
  "ResourcePrivacyScreen": true,
  "ResourceSoundproof": true,
  "ResourceShifts": "<string>",
  "Size": 123,
  "SizeIsLinkedToArea": true,
  "Capacity": 123,
  "Price": 123,
  "Area": "<string>",
  "SensorLastValue": "<string>",
  "IsSensorOccupied": true,
  "Notes": "<string>",
  "Available": true,
  "AvailableToAi": true,
  "NotesForAi": "<string>",
  "ShowPriceForAi": true,
  "PriceForAi": 123,
  "PositionX": 123,
  "PositionY": 123,
  "PositionZ": 123,
  "AccessControlGroupId": "<string>",
  "TunnelPrivateGroupId": "<string>",
  "CoworkerContractIds": "<string>",
  "CoworkerContractFullNames": "<string>",
  "CoworkerContractStartDates": "<string>",
  "AvailableFromTime": "<string>",
  "AvailableToTime": "<string>",
  "AvailableFromTimeLocal": "<string>",
  "AvailableToTimeLocal": "<string>",
  "ArchilogicUniqueId": "<string>",
  "FloorPlanLayoutAssetUniqueId": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

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-Read role.

Path Parameters

integer

required

The Id of the FloorPlanDesk record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/sys/floorplandesks/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/floorplandesks/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/floorplandesks/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the floor plan this unit belongs to.

string

Floor plan name.

integer

ID of the location that owns the floor plan.

string

Currency code of the location.

string

Location name.

integer

Maximum capacity of the floor plan.

integer

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

string

Full name of the assigned customer.

string

Company name of the assigned customer.

string

Record type of the assigned customer (Individual or Company).

string

Email address of the assigned customer.

string

Names of the teams the assigned customer belongs to.

integer

ID of the IoT sensor monitoring occupancy or environmental conditions in this unit.

string

Sensor name.

string

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

string

Type of the linked sensor (e.g. PresenceDetection, PeopleCounter, Temperature).

string

Most recent raw value reported by the sensor.

boolean

Whether the last sensor reading triggered a configured automation action.

string

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

integer

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.

integer

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

string

Linked resource name.

string

Resource type name of the linked resource.

integer

Maximum simultaneous bookings allowed for the linked resource.

boolean

Whether the linked resource has a projector.

boolean

Whether the linked resource provides internet access.

boolean

Whether the linked resource has a conference phone.

boolean

Whether the linked resource has a standard phone.

boolean

Whether the linked resource has a whiteboard.

boolean

Whether the linked resource has a large display or TV screen.

boolean

Whether the linked resource offers catering services.

boolean

Whether the linked resource provides tea and coffee.

boolean

Whether the linked resource provides drinks.

boolean

Whether the linked resource has a security lock.

boolean

Whether the linked resource is covered by CCTV.

boolean

Whether the linked resource has a voice recorder.

boolean

Whether the linked resource has air conditioning.

boolean

Whether the linked resource has heating.

boolean

Whether the linked resource has natural light.

boolean

Whether the linked resource has a standing desk.

boolean

Whether the linked resource is in a quiet zone.

boolean

Whether the linked resource has a wireless charger.

boolean

Whether the linked resource has a privacy screen.

boolean

Whether the linked resource is soundproofed.

string

Shift schedule defined on the linked resource.

number

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

boolean

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

number

Number of people this unit can accommodate at the same time.

number

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

string

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

string

Formatted display value of the last reading from the linked sensor.

boolean

Whether the linked sensor currently indicates this unit is occupied.

string

Internal notes about this unit, visible to admins only.

boolean

Whether this unit is currently available for assignment or booking.

boolean

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

string

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

boolean

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

number

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

integer

X coordinate of this unit’s position on the floor plan canvas.

integer

Y coordinate of this unit’s position on the floor plan canvas.

integer

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

string

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

string

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

string

Comma-separated list of contract IDs currently assigned to this unit.

string

Comma-separated list of customer names from contracts assigned to this unit.

string

Comma-separated list of start dates for contracts assigned to this unit.

string

UTC date/time from which this unit becomes available.

string

UTC date/time until which this unit is available.

string

Local date/time from which this unit becomes available (derived from AvailableFromTime).

string

Local date/time until which this unit is available (derived from AvailableToTime).

string

Unique identifier linking this unit to its corresponding element in an Archilogic 3D model.

string

Unique identifier linking this unit to a component in the associated floor plan layout template.

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

{
  "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,
  "Notes": null,
  "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
}

Get multiple FloorPlanDesksRetrieve multiple FloorPlanDesk records by their Ids in a single request.

Get one FloorPlanDesk

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

import requests

url = "https://spaces.nexudus.com/api/sys/floorplandesks/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/floorplandesks/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "FloorPlanId": 123,
  "FloorPlanName": "<string>",
  "FloorPlanBusinessId": 123,
  "FloorPlanBusinessCurrencyCode": "<string>",
  "FloorPlanBusinessName": "<string>",
  "FloorPlanCapacity": 123,
  "CoworkerId": 123,
  "CoworkerFullName": "<string>",
  "CoworkerCompanyName": "<string>",
  "CoworkerCoworkerType": "<string>",
  "CoworkerEmail": "<string>",
  "CoworkerTeamNames": "<string>",
  "SensorId": 123,
  "SensorName": "<string>",
  "SensorUnit": "<string>",
  "SensorSensorType": "<string>",
  "SensorLastReceivedValue": "<string>",
  "SensorLastValueTriggeredAction": true,
  "Name": "<string>",
  "ItemType": 123,
  "ResourceId": 123,
  "ResourceName": "<string>",
  "ResourceResourceTypeName": "<string>",
  "ResourceAllocation": 123,
  "ResourceProjector": true,
  "ResourceInternet": true,
  "ResourceConferencePhone": true,
  "ResourceStandardPhone": true,
  "ResourceWhiteBoard": true,
  "ResourceLargeDisplay": true,
  "ResourceCatering": true,
  "ResourceTeaAndCoffee": true,
  "ResourceDrinks": true,
  "ResourceSecurityLock": true,
  "ResourceCCTV": true,
  "ResourceVoiceRecorder": true,
  "ResourceAirConditioning": true,
  "ResourceHeating": true,
  "ResourceNaturalLight": true,
  "ResourceStandingDesk": true,
  "ResourceQuietZone": true,
  "ResourceWirelessCharger": true,
  "ResourcePrivacyScreen": true,
  "ResourceSoundproof": true,
  "ResourceShifts": "<string>",
  "Size": 123,
  "SizeIsLinkedToArea": true,
  "Capacity": 123,
  "Price": 123,
  "Area": "<string>",
  "SensorLastValue": "<string>",
  "IsSensorOccupied": true,
  "Notes": "<string>",
  "Available": true,
  "AvailableToAi": true,
  "NotesForAi": "<string>",
  "ShowPriceForAi": true,
  "PriceForAi": 123,
  "PositionX": 123,
  "PositionY": 123,
  "PositionZ": 123,
  "AccessControlGroupId": "<string>",
  "TunnelPrivateGroupId": "<string>",
  "CoworkerContractIds": "<string>",
  "CoworkerContractFullNames": "<string>",
  "CoworkerContractStartDates": "<string>",
  "AvailableFromTime": "<string>",
  "AvailableToTime": "<string>",
  "AvailableFromTimeLocal": "<string>",
  "AvailableToTimeLocal": "<string>",
  "ArchilogicUniqueId": "<string>",
  "FloorPlanLayoutAssetUniqueId": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200