Search FloorPlanDesks

GET

api

sys

floorplandesks

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

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

string

Filter by display value for FloorPlan.Name..

integer

Filter by display value for FloorPlan.Business.Id..

string

Filter by display value for FloorPlan.Business.Currency.Code..

string

Filter by display value for FloorPlan.Business.Name..

integer

Filter by display value for FloorPlan.Capacity..

integer

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

Filter by display value for Coworker.FullName..

string

Filter by display value for Coworker.CompanyName..

string

Filter by display value for Coworker.CoworkerType..

string

Filter by display value for Coworker.Email..

string

Filter by display value for Coworker.TeamNames..

integer

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

string

Filter by display value for Sensor.Name..

string

Filter by display value for Sensor.Unit..

string

Filter by display value for Sensor.SensorType..

string

Filter by display value for Sensor.LastReceivedValue..

boolean

Filter by display value for Sensor.LastValueTriggeredAction..

string

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

integer

Filter by type of unit: Office, DedicatedDesk, HotDesk, Other, or Room; AI private-office recommendations include only Office units.

integer

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

string

Filter by display value for Resource.Name..

string

Filter by display value for Resource.ResourceType.Name..

integer

Filter by display value for Resource.Allocation..

boolean

Filter by display value for Resource.Projector..

boolean

Filter by display value for Resource.Internet..

boolean

Filter by display value for Resource.ConferencePhone..

boolean

Filter by display value for Resource.StandardPhone..

boolean

Filter by display value for Resource.WhiteBoard..

boolean

Filter by display value for Resource.LargeDisplay..

boolean

Filter by display value for Resource.Catering..

boolean

Filter by display value for Resource.TeaAndCoffee..

boolean

Filter by display value for Resource.Drinks..

boolean

Filter by display value for Resource.SecurityLock..

boolean

Filter by display value for Resource.CCTV..

boolean

Filter by display value for Resource.VoiceRecorder..

boolean

Filter by display value for Resource.AirConditioning..

boolean

Filter by display value for Resource.Heating..

boolean

Filter by display value for Resource.NaturalLight..

boolean

Filter by display value for Resource.StandingDesk..

boolean

Filter by display value for Resource.QuietZone..

boolean

Filter by display value for Resource.WirelessCharger..

boolean

Filter by display value for Resource.PrivacyScreen..

boolean

Filter by display value for Resource.Soundproof..

string

Filter by display value for Resource.Shifts..

number

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

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

number

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

number

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

Filter by optional reporting group for floor plan units, such as a floor, zone, or wing.

string

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

boolean

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

string

Filter by optional internal notes about this unit, limited to 255 characters and not visible to customers.

boolean

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

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

string

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

boolean

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

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

integer

Filter by floor Plan Editor-managed horizontal canvas coordinate used to render this unit.

integer

Filter by floor Plan Editor-managed vertical canvas coordinate used to render this unit.

integer

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

string

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

string

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

string

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

string

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

string

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

string

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

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

string

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

string

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

string

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

string

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

Range Filters

integer

Filter by display value for FloorPlan.Business.Id. greater than or equal to this value.

integer

Filter by display value for FloorPlan.Business.Id. less than or equal to this value.

integer

Filter by display value for FloorPlan.Capacity. greater than or equal to this value.

integer

Filter by display value for FloorPlan.Capacity. less than or equal to this value.

integer

Filter by display value for Resource.Allocation. greater than or equal to this value.

integer

Filter by display value for Resource.Allocation. less than or equal to this value.

number

Filter by 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 greater than or equal to this value.

number

Filter by 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 less than or equal to this value.

number

Filter by target number of seats for this unit, used for occupancy reporting and as a minimum-capacity filter in AI private-office recommendations greater than or equal to this value.

number

Filter by target number of seats for this unit, used for occupancy reporting and as a minimum-capacity filter in AI private-office recommendations less than or equal to this value.

number

Filter by 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 greater than or equal to this value.

number

Filter by 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 less than or equal to this value.

number

Filter by optional price override in the location’s currency used for AI display and budget matching; null falls back to Price greater than or equal to this value.

number

Filter by optional price override in the location’s currency used for AI display and budget matching; null falls back to Price less than or equal to this value.

integer

Filter by floor Plan Editor-managed horizontal canvas coordinate used to render this unit greater than or equal to this value.

integer

Filter by floor Plan Editor-managed horizontal canvas coordinate used to render this unit less than or equal to this value.

integer

Filter by floor Plan Editor-managed vertical canvas coordinate used to render this unit greater than or equal to this value.

integer

Filter by floor Plan Editor-managed vertical canvas coordinate used to render this unit less than or equal to this value.

integer

Filter by floor Plan Editor-managed stacking order used to render overlapping units; higher values render on top greater than or equal to this value.

integer

Filter by floor Plan Editor-managed stacking order used to render overlapping units; higher values render on top less than or equal to this value.

string

Filter by optional inclusive UTC end of the reporting availability window; null means no end, and it must follow AvailableFromTime when both are set greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by optional inclusive UTC end of the reporting availability window; null means no end, and it must follow AvailableFromTime when both are set less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by derived location-local representation of AvailableFromTime populated by date-localization infrastructure; change AvailableFromTime instead greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by derived location-local representation of AvailableFromTime populated by date-localization infrastructure; change AvailableFromTime instead less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by derived location-local representation of AvailableToTime populated by date-localization infrastructure; change AvailableToTime instead greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by derived location-local representation of AvailableToTime populated by date-localization infrastructure; change AvailableToTime instead 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
}

Search FloorPlanDesks

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

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