Search FloorPlanLayouts

GET

api

sys

floorplanlayouts

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

import requests

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

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/floorplanlayouts', 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 FloorPlanLayout represents the overall layout configuration of a floor plan, including its dimensions, background image, and visual settings. Each floor plan can have one or more layouts to represent different configurations of the same space.

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 FloorPlanLayout-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 business linked to this record.

string

Filter by display name of the linked business (read-only).

string

Filter by the business currency code value for this floor plan layout.

string

Filter by the name value for this floor plan layout.

string

Filter by current file name of the background image (read-only; upload via the corresponding URL field).

string

Filter by uRL of a new file to upload as the background image.

boolean

Filter by set to true to remove the current background image file.

number

Filter by the size value for this floor plan layout.

string

Filter by current file name of the tracing image (read-only; upload via the corresponding URL field).

string

Filter by uRL of a new file to upload as the tracing image.

boolean

Filter by set to true to remove the current tracing image file.

string

Filter by current file name of the preview image (read-only; upload via the corresponding URL field).

string

Filter by uRL of a new file to upload as the preview image.

boolean

Filter by set to true to remove the current preview image file.

integer

Filter by the background image scale value for this floor plan layout.

integer

Filter by the tracing image scale value for this floor plan layout.

integer

Filter by the floor level value for this floor plan layout.

Range Filters

number

Filter by the size value for this floor plan layout greater than or equal to this value.

number

Filter by the size value for this floor plan layout less than or equal to this value.

integer

Filter by the background image scale value for this floor plan layout greater than or equal to this value.

integer

Filter by the background image scale value for this floor plan layout less than or equal to this value.

integer

Filter by the tracing image scale value for this floor plan layout greater than or equal to this value.

integer

Filter by the tracing image scale value for this floor plan layout less than or equal to this value.

integer

Filter by the floor level value for this floor plan layout greater than or equal to this value.

integer

Filter by the floor level value for this floor plan layout 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/floorplanlayouts?page=1&size=15&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

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

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

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

data = response.json()

Response

200

FloorPlanLayout[]

The list of FloorPlanLayout records matching the query. See the Get one FloorPlanLayout 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,
      "Name": "",
      "BackgroundImageFileName": null,
      "NewBackgroundImageUrl": null,
      "ClearBackgroundImageFile": null,
      "Size": 0,
      "TracingImageFileName": null,
      "NewTracingImageUrl": null,
      "ClearTracingImageFile": null,
      "PreviewImageFileName": null,
      "NewPreviewImageUrl": null,
      "ClearPreviewImageFile": null,
      "BackgroundImageScale": 0,
      "TracingImageScale": 0,
      "FloorLevel": 0,
      "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": "FloorPlanLayout 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 FloorPlanLayoutRetrieve a single FloorPlanLayout record by its Id.

Search FloorPlanLayouts

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

import requests

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

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/floorplanlayouts', 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