Search FloorPlanDesks

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.

Query Parameters

Pagination & Sorting

page

integer

default:"1"

The page number to retrieve.

size

integer

default:"25"

The number of records per page.

orderBy

string

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

dir

integer

Sort direction. 1 for ascending, -1 for descending.

Filters

FloorPlanDesk_FloorPlan

integer

Filter by Floor Plan Id.

FloorPlanDesk_FloorPlan_Name

string

Filter by Floor Plan Name.

FloorPlanDesk_FloorPlan_Business_Id

integer

Filter by Floor Plan Business Id.

FloorPlanDesk_FloorPlan_Business_Currency_Code

string

Filter by Floor Plan Business Currency Code.

FloorPlanDesk_FloorPlan_Business_Name

string

Filter by Floor Plan Business Name.

FloorPlanDesk_FloorPlan_Capacity

integer

Filter by Floor Plan Capacity.

FloorPlanDesk_Coworker

integer

Filter by Coworker Id.

FloorPlanDesk_Coworker_FullName

string

Filter by Coworker Full Name.

FloorPlanDesk_Coworker_CompanyName

string

Filter by Coworker Company Name.

FloorPlanDesk_Coworker_CoworkerType

string

Filter by Coworker Coworker Type.

FloorPlanDesk_Coworker_Email

string

Filter by Coworker Email.

FloorPlanDesk_Coworker_TeamNames

string

Filter by Coworker Team Names.

FloorPlanDesk_Sensor

integer

Filter by Sensor Id.

FloorPlanDesk_Sensor_Name

string

Filter by Sensor Name.

FloorPlanDesk_Sensor_Unit

string

Filter by Sensor Unit.

FloorPlanDesk_Sensor_SensorType

string

Filter by Sensor Sensor Type.

FloorPlanDesk_Sensor_LastReceivedValue

string

Filter by Sensor Last Received Value.

FloorPlanDesk_Sensor_LastValueTriggeredAction

boolean

Filter by Sensor Last Value Triggered Action.

FloorPlanDesk_Name

string

Filter by Name.

FloorPlanDesk_ItemType

integer

Filter by Item Type.

FloorPlanDesk_Resource

integer

Filter by Resource Id.

FloorPlanDesk_Resource_Name

string

Filter by Resource Name.

FloorPlanDesk_Resource_ResourceType_Name

string

Filter by Resource Resource Type Name.

FloorPlanDesk_Resource_Allocation

integer

Filter by Resource Allocation.

FloorPlanDesk_Resource_Projector

boolean

Filter by Resource Projector.

FloorPlanDesk_Resource_Internet

boolean

Filter by Resource Internet.

FloorPlanDesk_Resource_ConferencePhone

boolean

Filter by Resource Conference Phone.

FloorPlanDesk_Resource_StandardPhone

boolean

Filter by Resource Standard Phone.

FloorPlanDesk_Resource_WhiteBoard

boolean

Filter by Resource White Board.

FloorPlanDesk_Resource_LargeDisplay

boolean

Filter by Resource Large Display.

FloorPlanDesk_Resource_Catering

boolean

Filter by Resource Catering.

FloorPlanDesk_Resource_TeaAndCoffee

boolean

Filter by Resource Tea And Coffee.

FloorPlanDesk_Resource_Drinks

boolean

Filter by Resource Drinks.

FloorPlanDesk_Resource_SecurityLock

boolean

Filter by Resource Security Lock.

FloorPlanDesk_Resource_CCTV

boolean

Filter by Resource CCTV.

FloorPlanDesk_Resource_VoiceRecorder

boolean

Filter by Resource Voice Recorder.

FloorPlanDesk_Resource_AirConditioning

boolean

Filter by Resource Air Conditioning.

FloorPlanDesk_Resource_Heating

boolean

Filter by Resource Heating.

FloorPlanDesk_Resource_NaturalLight

boolean

Filter by Resource Natural Light.

FloorPlanDesk_Resource_StandingDesk

boolean

Filter by Resource Standing Desk.

FloorPlanDesk_Resource_QuietZone

boolean

Filter by Resource Quiet Zone.

FloorPlanDesk_Resource_WirelessCharger

boolean

Filter by Resource Wireless Charger.

FloorPlanDesk_Resource_PrivacyScreen

boolean

Filter by Resource Privacy Screen.

FloorPlanDesk_Resource_Soundproof

boolean

Filter by Resource Soundproof.

FloorPlanDesk_Resource_Shifts

string

Filter by Resource Shifts.

FloorPlanDesk_Size

number

Filter by Size.

FloorPlanDesk_SizeIsLinkedToArea

boolean

Filter by Size Is Linked To Area.

FloorPlanDesk_Capacity

number

Filter by Capacity.

FloorPlanDesk_Price

number

Filter by Price.

FloorPlanDesk_Area

string

Filter by Area.

FloorPlanDesk_SensorLastValue

string

Filter by Sensor Last Value.

FloorPlanDesk_IsSensorOccupied

boolean

Filter by Is Sensor Occupied.

FloorPlanDesk_Notes

string

Filter by Notes.

FloorPlanDesk_Available

boolean

Filter by Available.

FloorPlanDesk_PositionX

integer

Filter by Position X.

FloorPlanDesk_PositionY

integer

Filter by Position Y.

FloorPlanDesk_PositionZ

integer

Filter by Position Z.

FloorPlanDesk_AccessControlGroupId

string

Filter by Access Control Group Id.

FloorPlanDesk_TunnelPrivateGroupId

string

Filter by Tunnel Private Group Id.

FloorPlanDesk_CoworkerContractIds

string

Filter by Coworker Contract Ids.

FloorPlanDesk_CoworkerContractFullNames

string

Filter by Coworker Contract Full Names.

FloorPlanDesk_CoworkerContractStartDates

string

Filter by Coworker Contract Start Dates.

FloorPlanDesk_AvailableFromTime

string

Filter by Available From Time.

FloorPlanDesk_AvailableToTime

string

Filter by Available To Time.

FloorPlanDesk_AvailableFromTimeLocal

string

Filter by Available From Time Local.

FloorPlanDesk_AvailableToTimeLocal

string

Filter by Available To Time Local.

FloorPlanDesk_ArchilogicUniqueId

string

Filter by Archilogic Unique Id.

FloorPlanDesk_FloorPlanLayoutAssetUniqueId

string

Filter by Floor Plan Layout Asset Unique Id.

Range Filters

from_FloorPlanDesk_FloorPlanBusinessId

integer

Filter by floor plan business id greater than or equal to this value.

to_FloorPlanDesk_FloorPlanBusinessId

integer

Filter by floor plan business id less than or equal to this value.

from_FloorPlanDesk_FloorPlanCapacity

integer

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

to_FloorPlanDesk_FloorPlanCapacity

integer

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

from_FloorPlanDesk_ResourceAllocation

integer

Filter by resource allocation greater than or equal to this value.

to_FloorPlanDesk_ResourceAllocation

integer

Filter by resource allocation less than or equal to this value.

from_FloorPlanDesk_Size

number

Filter by size greater than or equal to this value.

to_FloorPlanDesk_Size

number

Filter by size less than or equal to this value.

from_FloorPlanDesk_Capacity

number

Filter by capacity greater than or equal to this value.

to_FloorPlanDesk_Capacity

number

Filter by capacity less than or equal to this value.

from_FloorPlanDesk_Price

number

Filter by price greater than or equal to this value.

to_FloorPlanDesk_Price

number

Filter by price less than or equal to this value.

from_FloorPlanDesk_PositionX

integer

Filter by position x greater than or equal to this value.

to_FloorPlanDesk_PositionX

integer

Filter by position x less than or equal to this value.

from_FloorPlanDesk_PositionY

integer

Filter by position y greater than or equal to this value.

to_FloorPlanDesk_PositionY

integer

Filter by position y less than or equal to this value.

from_FloorPlanDesk_PositionZ

integer

Filter by position z greater than or equal to this value.

to_FloorPlanDesk_PositionZ

integer

Filter by position z less than or equal to this value.

from_FloorPlanDesk_AvailableFromTime

string

Filter by available from time greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_FloorPlanDesk_AvailableFromTime

string

Filter by available from time less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_FloorPlanDesk_AvailableToTime

string

Filter by available to time greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_FloorPlanDesk_AvailableToTime

string

Filter by available to time less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_FloorPlanDesk_AvailableFromTimeLocal

string

Filter by available from time local greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_FloorPlanDesk_AvailableFromTimeLocal

string

Filter by available from time local less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_FloorPlanDesk_AvailableToTimeLocal

string

Filter by available to time local greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_FloorPlanDesk_AvailableToTimeLocal

string

Filter by available to time local less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_FloorPlanDesk_CreatedOn

string

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

to_FloorPlanDesk_CreatedOn

string

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

from_FloorPlanDesk_UpdatedOn

string

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

to_FloorPlanDesk_UpdatedOn

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=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

Filtering by Name

curl -X GET \
  "https://spaces.nexudus.com/api/sys/floorplandesks?FloorPlanDesk_Name=example-value&orderBy=Name&dir=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

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=-1" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

200

Records

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

CurrentPage

integer

Current page number.

CurrentPageSize

integer

Number of records per page.

CurrentOrderField

string

The field used for sorting.

CurrentSortDirection

integer

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

FirstItem

integer

Index of the first item on the current page.

LastItem

integer

Index of the last item on the current page.

TotalItems

integer

Total number of matching records across all pages.

TotalPages

integer

Total number of pages.

HasNextPage

boolean

Whether there is a next page of results.

HasPreviousPage

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,
      "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
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

​Authentication

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by Name

​Range filters

​Response

​200

Authentication

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200