Get one FloorPlan

GET

api

sys

floorplans

{id}

Get one FloorPlan

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

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

fetch('https://spaces.nexudus.com/api/sys/floorplans/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "BusinessName": "<string>",
  "BusinessCurrencyCode": "<string>",
  "FloorPlanLayoutId": 123,
  "FloorPlanLayoutName": "<string>",
  "Name": "<string>",
  "BackgroundImageFileName": "<string>",
  "NewBackgroundImageUrl": "<string>",
  "ClearBackgroundImageFile": true,
  "DisplayBackground": true,
  "BackgroundScale": 123,
  "PositionX": 123,
  "PositionY": 123,
  "FloorLevel": 123,
  "Scale": 123,
  "Capacity": 123,
  "ArchilogicUniqueId": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

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-Read role.

Path Parameters

integer

required

The Id of the FloorPlan record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/sys/floorplans/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/floorplans/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/floorplans/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the required location that owns this floor plan.

string

Display value for Business.Name..

string

Display value for Business.Currency.Code..

integer

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

Display value for FloorPlanLayout.Name..

string

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

string

Filename of the currently stored background/tracing image.

string

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

boolean

Set to true to remove the current background/tracing image from this floor plan.

boolean

Whether the uploaded background image is displayed for an image-based floor plan.

integer

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

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

integer

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

integer

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

number

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

integer

Optional maximum number of simultaneous bookings accepted across this floor plan; null means unlimited.

string

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

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

{
  "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
}

Get one FloorPlan

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

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

fetch('https://spaces.nexudus.com/api/sys/floorplans/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "BusinessName": "<string>",
  "BusinessCurrencyCode": "<string>",
  "FloorPlanLayoutId": 123,
  "FloorPlanLayoutName": "<string>",
  "Name": "<string>",
  "BackgroundImageFileName": "<string>",
  "NewBackgroundImageUrl": "<string>",
  "ClearBackgroundImageFile": true,
  "DisplayBackground": true,
  "BackgroundScale": 123,
  "PositionX": 123,
  "PositionY": 123,
  "FloorLevel": 123,
  "Scale": 123,
  "Capacity": 123,
  "ArchilogicUniqueId": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200