Search FloorPlanDesks

GET

api

sys

floorplandesks

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

import requests

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

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', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

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

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

integer

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

string

Filter by floor plan name.

integer

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

string

Filter by currency code of the location.

string

Filter by location name.

integer

Filter by maximum capacity of the floor plan.

integer

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

string

Filter by full name of the assigned customer.

string

Filter by company name of the assigned customer.

string

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

string

Filter by email address of the assigned customer.

string

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

integer

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

string

Filter by sensor name.

string

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

string

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

string

Filter by most recent raw value reported by the sensor.

boolean

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

string

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

integer

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

integer

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

string

Filter by linked resource name.

string

Filter by resource type name of the linked resource.

integer

Filter by maximum simultaneous bookings allowed for the linked resource.

boolean

Filter by whether the linked resource has a projector.

boolean

Filter by whether the linked resource provides internet access.

boolean

Filter by whether the linked resource has a conference phone.

boolean

Filter by whether the linked resource has a standard phone.

boolean

Filter by whether the linked resource has a whiteboard.

boolean

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

boolean

Filter by whether the linked resource offers catering services.

boolean

Filter by whether the linked resource provides tea and coffee.

boolean

Filter by whether the linked resource provides drinks.

boolean

Filter by whether the linked resource has a security lock.

boolean

Filter by whether the linked resource is covered by CCTV.

boolean

Filter by whether the linked resource has a voice recorder.

boolean

Filter by whether the linked resource has air conditioning.

boolean

Filter by whether the linked resource has heating.

boolean

Filter by whether the linked resource has natural light.

boolean

Filter by whether the linked resource has a standing desk.

boolean

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

boolean

Filter by whether the linked resource has a wireless charger.

boolean

Filter by whether the linked resource has a privacy screen.

boolean

Filter by whether the linked resource is soundproofed.

string

Filter by shift schedule defined on the linked resource.

number

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

boolean

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

number

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

number

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

string

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

string

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

boolean

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

string

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

boolean

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

boolean

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

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’).

boolean

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

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

integer

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

integer

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

integer

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

Range Filters

integer

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

integer

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

integer

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

integer

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

integer

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

integer

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

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.

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.

number

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

number

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

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.

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.

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.

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.

integer

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

integer

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

integer

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

integer

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

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.

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.

string

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

string

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

string

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

string

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

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.

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.

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.

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.

string

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

string

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

string

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

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"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/floorplandesks?' + new URLSearchParams({
    page: 1,
    size: 15,
    orderBy: 'Name',
    dir: 1 // Ascending
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/floorplandesks',
    params={
        'page': 1,
        'size': 15,
        'orderBy': 'Name',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

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"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/floorplandesks?' + new URLSearchParams({
    FloorPlanDesk_Name: 'example-value',
    orderBy: 'Name',
    dir: 1
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/floorplandesks',
    params={
        'FloorPlanDesk_Name': 'example-value',
        'orderBy': 'Name',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

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"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/floorplandesks?' + new URLSearchParams({
    from_FloorPlanDesk_UpdatedOn: '2025-01-01T00:00',
    to_FloorPlanDesk_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/floorplandesks',
    params={
        'from_FloorPlanDesk_UpdatedOn': '2025-01-01T00:00',
        'to_FloorPlanDesk_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

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.

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

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

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

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

import requests

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

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', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Query Parameters

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

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200