Skip to main content
GET
/
api
/
sys
/
floorplandesks
/
{id}
{
  "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,
  "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>"
}

​
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

​
id
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"

​
Response

​
200

​
FloorPlanId
integer
Floor Plan Id.
​
FloorPlanName
string
Floor Plan Name.
​
FloorPlanBusinessId
integer
Floor Plan Business Id.
​
FloorPlanBusinessCurrencyCode
string
Floor Plan Business Currency Code.
​
FloorPlanBusinessName
string
Floor Plan Business Name.
​
FloorPlanCapacity
integer
Floor Plan Capacity.
​
CoworkerId
integer
Coworker Id.
​
CoworkerFullName
string
Coworker Full Name.
​
CoworkerCompanyName
string
Coworker Company Name.
​
CoworkerCoworkerType
string
Coworker Coworker Type.
​
CoworkerEmail
string
Coworker Email.
​
CoworkerTeamNames
string
Coworker Team Names.
​
SensorId
integer
Sensor Id.
​
SensorName
string
Sensor Name.
​
SensorUnit
string
Sensor Unit.
​
SensorSensorType
string
Sensor Sensor Type.
​
SensorLastReceivedValue
string
Sensor Last Received Value.
​
SensorLastValueTriggeredAction
boolean
Sensor Last Value Triggered Action.
​
Name
string
Name.
​
ItemType
integer
Item Type.
​
ResourceId
integer
Resource Id.
​
ResourceName
string
Resource Name.
​
ResourceResourceTypeName
string
Resource Resource Type Name.
​
ResourceAllocation
integer
Resource Allocation.
​
ResourceProjector
boolean
Resource Projector.
​
ResourceInternet
boolean
Resource Internet.
​
ResourceConferencePhone
boolean
Resource Conference Phone.
​
ResourceStandardPhone
boolean
Resource Standard Phone.
​
ResourceWhiteBoard
boolean
Resource White Board.
​
ResourceLargeDisplay
boolean
Resource Large Display.
​
ResourceCatering
boolean
Resource Catering.
​
ResourceTeaAndCoffee
boolean
Resource Tea And Coffee.
​
ResourceDrinks
boolean
Resource Drinks.
​
ResourceSecurityLock
boolean
Resource Security Lock.
​
ResourceCCTV
boolean
Resource CCTV.
​
ResourceVoiceRecorder
boolean
Resource Voice Recorder.
​
ResourceAirConditioning
boolean
Resource Air Conditioning.
​
ResourceHeating
boolean
Resource Heating.
​
ResourceNaturalLight
boolean
Resource Natural Light.
​
ResourceStandingDesk
boolean
Resource Standing Desk.
​
ResourceQuietZone
boolean
Resource Quiet Zone.
​
ResourceWirelessCharger
boolean
Resource Wireless Charger.
​
ResourcePrivacyScreen
boolean
Resource Privacy Screen.
​
ResourceSoundproof
boolean
Resource Soundproof.
​
ResourceShifts
string
Resource Shifts.
​
Size
number
Size.
​
SizeIsLinkedToArea
boolean
Size Is Linked To Area.
​
Capacity
number
Capacity.
​
Price
number
Price.
​
Area
string
Area.
​
SensorLastValue
string
Sensor Last Value.
​
IsSensorOccupied
boolean
Is Sensor Occupied.
​
Notes
string
Notes.
​
Available
boolean
Available.
​
PositionX
integer
Position X.
​
PositionY
integer
Position Y.
​
PositionZ
integer
Position Z.
​
AccessControlGroupId
string
Access Control Group Id.
​
TunnelPrivateGroupId
string
Tunnel Private Group Id.
​
CoworkerContractIds
string
Coworker Contract Ids.
​
CoworkerContractFullNames
string
Coworker Contract Full Names.
​
CoworkerContractStartDates
string
Coworker Contract Start Dates.
​
AvailableFromTime
string
Available From Time.
​
AvailableToTime
string
Available To Time.
​
AvailableFromTimeLocal
string
Available From Time Local.
​
AvailableToTimeLocal
string
Available To Time Local.
​
ArchilogicUniqueId
string
Archilogic Unique Id.
​
FloorPlanLayoutAssetUniqueId
string
Floor Plan Layout Asset Unique Id.
​
Id
integer
Unique record identifier.
​
UniqueId
string
UUID of the record.
​
CreatedOn
string
Date and time the record was created (ISO 8601).
​
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
​
UpdatedBy
string
Email of the user who last updated this record.
​
IsNew
boolean
Whether the record was recently created.
​
SystemId
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,
  "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
}