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, called a floor plan unit by operators, represents an office, desk, room, or other area on a location’s floor plan that can be assigned through contracts, connected to a bookable resource, and included in occupancy reporting.

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 required floor plan that owns this unit and determines its location.

string

Display value for FloorPlan.Name..

integer

Display value for FloorPlan.Business.Id..

string

Display value for FloorPlan.Business.Currency.Code..

string

Display value for FloorPlan.Business.Name..

integer

Display value for FloorPlan.Capacity..

integer

ID of the optional customer occupying this unit; normally assign occupancy through a contract, and the customer cannot be changed while contracts are linked.

string

Display value for Coworker.FullName..

string

Display value for Coworker.CompanyName..

string

Display value for Coworker.CoworkerType..

string

Display value for Coworker.Email..

string

Display value for Coworker.TeamNames..

integer

ID of the optional IoT sensor whose latest reading and occupancy action are reported for this unit.

string

Display value for Sensor.Name..

string

Display value for Sensor.Unit..

string

Display value for Sensor.SensorType..

string

Display value for Sensor.LastReceivedValue..

boolean

Display value for Sensor.LastValueTriggeredAction..

string

Required, non-empty display name of the floor plan unit, such as ‘Office 3’ or ‘Hot Desk 12’.

integer

Type of unit: Office, DedicatedDesk, HotDesk, Other, or Room; AI private-office recommendations include only Office units. See eFloorPlanItemType enum values: 1 = Office, 2 = DedicatedDesk, 3 = HotDesk, 4 = Other, 5 = Room.

integer

ID of the optional bookable resource connected to this unit so customers can book it through a floor plan view.

string

Display value for Resource.Name..

string

Display value for Resource.ResourceType.Name..

integer

Display value for Resource.Allocation..

boolean

Display value for Resource.Projector..

boolean

Display value for Resource.Internet..

boolean

Display value for Resource.ConferencePhone..

boolean

Display value for Resource.StandardPhone..

boolean

Display value for Resource.WhiteBoard..

boolean

Display value for Resource.LargeDisplay..

boolean

Display value for Resource.Catering..

boolean

Display value for Resource.TeaAndCoffee..

boolean

Display value for Resource.Drinks..

boolean

Display value for Resource.SecurityLock..

boolean

Display value for Resource.CCTV..

boolean

Display value for Resource.VoiceRecorder..

boolean

Display value for Resource.AirConditioning..

boolean

Display value for Resource.Heating..

boolean

Display value for Resource.NaturalLight..

boolean

Display value for Resource.StandingDesk..

boolean

Display value for Resource.QuietZone..

boolean

Display value for Resource.WirelessCharger..

boolean

Display value for Resource.PrivacyScreen..

boolean

Display value for Resource.Soundproof..

string

Display value for Resource.Shifts..

number

Floor area stored in square metres; the Admin UI may display and convert it to square feet, and a linked layout area can overwrite it when SizeIsLinkedToArea is true.

boolean

Whether Size is synchronized from the Floor Plan Editor area identified by FloorPlanLayoutAssetUniqueId when that linked area exists.

number

Target number of seats for this unit, used for occupancy reporting and as a minimum-capacity filter in AI private-office recommendations.

number

Target price in the floor plan location’s currency for revenue occupancy reporting; it is not a billing price and is the AI price fallback when PriceForAi is null.

string

Optional reporting group for floor plan units, such as a floor, zone, or wing.

string

Read-only string containing the latest value received from the linked sensor; sensor processing updates and clears it.

boolean

Whether the linked sensor’s occupancy action currently marks this unit as occupied; sensor processing controls this read-only value.

string

Optional internal notes about this unit, limited to 255 characters and not visible to customers.

boolean

Whether this unit is in service and can be assigned to contracts or bookings; current availability also requires the UTC availability window to include now.

boolean

Whether AI channels may include this unit in private-office recommendations; the unit must also be an available Office.

string

Optional notes for AI recommendations, limited to 1,024 characters, such as accessibility, furnishing, natural light, or noise information.

boolean

Whether AI recommendations may show a price for this unit; this does not stop PriceForAi or Price from being used to match a customer’s budget.

number

Optional price override in the location’s currency used for AI display and budget matching; null falls back to Price.

integer

Floor Plan Editor-managed horizontal canvas coordinate used to render this unit.

integer

Floor Plan Editor-managed vertical canvas coordinate used to render this unit.

integer

Floor Plan Editor-managed stacking order used to render overlapping units; higher values render on top.

string

Obsolete single-provider access-control group identifier retained as a fallback for legacy records; AccessControlGroupIds is the supported replacement.

string

Internal virtual LAN or RADIUS tunnel group identifier used by network integrations for this unit.

string

Read-only comma-separated IDs of contracts linked to this unit; update the contracts rather than this projection.

string

Read-only comma-separated customer names from contracts linked to this unit; update the contracts rather than this projection.

string

Read-only comma-separated start dates from contracts linked to this unit; update the contracts rather than this projection.

string

Inclusive UTC start of the reporting availability window; when omitted on create it defaults to the start of the current day at the location, and it must precede AvailableToTime when both are set.

string

Optional inclusive UTC end of the reporting availability window; null means no end, and it must follow AvailableFromTime when both are set.

string

Derived location-local representation of AvailableFromTime populated by date-localization infrastructure; change AvailableFromTime instead.

string

Derived location-local representation of AvailableToTime populated by date-localization infrastructure; change AvailableToTime instead.

string

Integration-managed Archilogic element GUID used to map this unit into a 3D scene; changing it can break scene synchronization.

string

Floor Plan Editor-managed area GUID that links this unit to a layout asset and drives linked Size synchronization.

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