Search FloorPlans

GET

api

sys

floorplans

Search FloorPlans

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

import requests

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

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/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 FloorPlan is a visual diagram representing a single floor of a location. Floor plans are used by admins and customers to get an overview of the space layout, including rooms, desks, and other areas. Each floor plan belongs to a location (Business) and can optionally reference a FloorPlanLayout template. A background/tracing image can be uploaded to overlay the drawn areas, and its position and scale can be adjusted independently from the floor plan’s own scale. Once created, floor plan units (FloorPlanDesks) are added to the floor plan to represent individual bookable or non-bookable areas such as offices, dedicated desks, hot desks, and meeting rooms.

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 location this floor plan belongs to.

string

Filter by location name.

string

Filter by currency code of the location.

integer

Filter by iD of the floor plan layout template to apply to this floor plan.

string

Filter by floor plan layout name.

string

Filter by display name of the floor plan (e.g. ‘Ground Floor’, ‘Level 2’).

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 background/tracing image is visible when the floor plan is rendered.

integer

Filter by zoom/scale factor applied to the background/tracing image, expressed as a percentage (e.g. 100 = original size).

integer

Filter by horizontal offset (in pixels) of the background image within the floor plan canvas.

integer

Filter by vertical offset (in pixels) of the background image within the floor plan canvas.

integer

Filter by floor number used to order floor plans (e.g. 0 = ground floor, 1 = first floor, -1 = basement).

number

Filter by real-world scale of the floor plan, representing how many real-world units correspond to one canvas unit.

integer

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

string

Filter by unique identifier used to link this floor plan to a corresponding Archilogic 3D model.

Range Filters

integer

Filter by zoom/scale factor applied to the background/tracing image, expressed as a percentage (e.g. 100 = original size) greater than or equal to this value.

integer

Filter by zoom/scale factor applied to the background/tracing image, expressed as a percentage (e.g. 100 = original size) less than or equal to this value.

integer

Filter by horizontal offset (in pixels) of the background image within the floor plan canvas greater than or equal to this value.

integer

Filter by horizontal offset (in pixels) of the background image within the floor plan canvas less than or equal to this value.

integer

Filter by vertical offset (in pixels) of the background image within the floor plan canvas greater than or equal to this value.

integer

Filter by vertical offset (in pixels) of the background image within the floor plan canvas less than or equal to this value.

integer

Filter by floor number used to order floor plans (e.g. 0 = ground floor, 1 = first floor, -1 = basement) greater than or equal to this value.

integer

Filter by floor number used to order floor plans (e.g. 0 = ground floor, 1 = first floor, -1 = basement) less than or equal to this value.

number

Filter by real-world scale of the floor plan, representing how many real-world units correspond to one canvas unit greater than or equal to this value.

number

Filter by real-world scale of the floor plan, representing how many real-world units correspond to one canvas unit less than or equal to this value.

integer

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

integer

Filter by maximum number of people this floor can accommodate at the same time 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
}

Get one FloorPlanRetrieve a single FloorPlan record by its Id.

Search FloorPlans

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

import requests

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

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