Search FloorPlans

GET

api

sys

floorplans

Search FloorPlans

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

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/floorplans', 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 floor plan represents one floor at a location and groups the bookable or assignable floor plan units shown through an uploaded image, a Nexudus Floor Plan Editor layout, or an Archilogic 3D scene.

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 FloorPlan-List role.

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 location that owns this floor plan.

string

Filter by display value for Business.Name..

string

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

integer

Filter by iD of the optional Nexudus Floor Plan Editor layout associated with this floor plan; the layout must belong to a location the user can access.

string

Filter by display value for FloorPlanLayout.Name..

string

Filter by required display name; changing it also updates the associated editor layout name and floor plan unit names containing the previous name.

string

Filter by filename of the currently stored background/tracing image.

string

Filter by uRL of a new background/tracing image to upload. The image will be fetched and stored when the floor plan is saved.

boolean

Filter by set to true to remove the current background/tracing image from this floor plan.

boolean

Filter by whether the uploaded background image is displayed for an image-based floor plan.

integer

Filter by integer percentage used to scale floor plan unit coordinates over the background image; 100 is full scale, values above 100 are capped at 100 when rendered, and non-positive values render at 33.

integer

Filter by legacy horizontal floor plan offset; the current editor stores each unit’s horizontal canvas coordinate in FloorPlanDesk.PositionX instead.

integer

Filter by legacy vertical floor plan offset; the current editor stores each unit’s vertical canvas coordinate in FloorPlanDesk.PositionY instead.

integer

Filter by legacy floor-level value; Nexudus Floor Plan Editor layouts maintain the active level in FloorPlanLayout.FloorLevel instead.

number

Filter by legacy decimal floor plan scale retained for older image-based records; the current editor does not expose or interpret this field.

integer

Filter by optional maximum number of simultaneous bookings accepted across this floor plan; null means unlimited.

string

Filter by integration-managed Archilogic scene GUID used to load the linked 3D floor plan; changing it can break the scene and unit mapping.

Range Filters

integer

Filter by legacy horizontal floor plan offset; the current editor stores each unit’s horizontal canvas coordinate in FloorPlanDesk.PositionX instead greater than or equal to this value.

integer

Filter by legacy horizontal floor plan offset; the current editor stores each unit’s horizontal canvas coordinate in FloorPlanDesk.PositionX instead less than or equal to this value.

integer

Filter by legacy vertical floor plan offset; the current editor stores each unit’s vertical canvas coordinate in FloorPlanDesk.PositionY instead greater than or equal to this value.

integer

Filter by legacy vertical floor plan offset; the current editor stores each unit’s vertical canvas coordinate in FloorPlanDesk.PositionY instead less than or equal to this value.

integer

Filter by legacy floor-level value; Nexudus Floor Plan Editor layouts maintain the active level in FloorPlanLayout.FloorLevel instead greater than or equal to this value.

integer

Filter by legacy floor-level value; Nexudus Floor Plan Editor layouts maintain the active level in FloorPlanLayout.FloorLevel instead less than or equal to this value.

number

Filter by legacy decimal floor plan scale retained for older image-based records; the current editor does not expose or interpret this field greater than or equal to this value.

number

Filter by legacy decimal floor plan scale retained for older image-based records; the current editor does not expose or interpret this field less than or equal to this value.

integer

Filter by optional maximum number of simultaneous bookings accepted across this floor plan; null means unlimited greater than or equal to this value.

integer

Filter by optional maximum number of simultaneous bookings accepted across this floor plan; null means unlimited less than or equal to this value.

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/floorplans?page=1&size=15&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/floorplans?' + 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/floorplans',
    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/floorplans?FloorPlan_Name=example-value&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/floorplans?' + new URLSearchParams({
    FloorPlan_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/floorplans',
    params={
        'FloorPlan_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/floorplans?from_FloorPlan_UpdatedOn=2025-01-01T00:00&to_FloorPlan_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/floorplans?' + new URLSearchParams({
    from_FloorPlan_UpdatedOn: '2025-01-01T00:00',
    to_FloorPlan_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/floorplans',
    params={
        'from_FloorPlan_UpdatedOn': '2025-01-01T00:00',
        'to_FloorPlan_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

FloorPlan[]

The list of FloorPlan records matching the query. See the Get one FloorPlan endpoint for the full list of properties returned for each record.

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": [
    {
      "BusinessId": 0,
      "BusinessName": null,
      "BusinessCurrencyCode": null,
      "FloorPlanLayoutId": null,
      "FloorPlanLayoutName": null,
      "Name": "",
      "BackgroundImageFileName": null,
      "NewBackgroundImageUrl": null,
      "ClearBackgroundImageFile": null,
      "DisplayBackground": false,
      "BackgroundScale": 0,
      "PositionX": 0,
      "PositionY": 0,
      "FloorLevel": 0,
      "Scale": 0,
      "Capacity": null,
      "ArchilogicUniqueId": 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": "FloorPlan 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 FloorPlans

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

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/floorplans', 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

Query Parameters

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

Authentication

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200