Skip to main content
GET
/
api
/
sys
/
floorplanlayouts
/
{id}
Get one FloorPlanLayout
curl --request GET \
  --url https://spaces.nexudus.com/api/sys/floorplanlayouts/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "BusinessId": 123,
  "BusinessName": "<string>",
  "BusinessCurrencyCode": "<string>",
  "Name": "<string>",
  "BackgroundImageFileName": "<string>",
  "NewBackgroundImageUrl": "<string>",
  "ClearBackgroundImageFile": true,
  "Size": 123,
  "TracingImageFileName": "<string>",
  "NewTracingImageUrl": "<string>",
  "ClearTracingImageFile": true,
  "PreviewImageFileName": "<string>",
  "NewPreviewImageUrl": "<string>",
  "ClearPreviewImageFile": true,
  "BackgroundImageScale": 123,
  "TracingImageScale": 123,
  "FloorLevel": 123,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}
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-Read role.

​
Path Parameters

​
id
integer
required
The Id of the FloorPlanLayout record to retrieve.

​
Code Examples

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

​
Response

​
200

​
BusinessId
integer
ID of the business linked to this record.
​
BusinessName
string
Display name of the linked business (read-only).
​
BusinessCurrencyCode
string
The business currency code value for this floor plan layout.
​
Name
string
The name value for this floor plan layout.
​
BackgroundImageFileName
string
Current file name of the background image (read-only; upload via the corresponding URL field).
​
NewBackgroundImageUrl
string
URL of a new file to upload as the background image.
​
ClearBackgroundImageFile
boolean
Set to true to remove the current background image file.
​
Size
number
The size value for this floor plan layout.
​
TracingImageFileName
string
Current file name of the tracing image (read-only; upload via the corresponding URL field).
​
NewTracingImageUrl
string
URL of a new file to upload as the tracing image.
​
ClearTracingImageFile
boolean
Set to true to remove the current tracing image file.
​
PreviewImageFileName
string
Current file name of the preview image (read-only; upload via the corresponding URL field).
​
NewPreviewImageUrl
string
URL of a new file to upload as the preview image.
​
ClearPreviewImageFile
boolean
Set to true to remove the current preview image file.
​
BackgroundImageScale
integer
The background image scale value for this floor plan layout.
​
TracingImageScale
integer
The tracing image scale value for this floor plan layout.
​
FloorLevel
integer
The floor level value for this floor plan layout.
​
Id
integer
Unique record identifier.
​
UniqueId
string
UUID of the record.
​
CreatedOn
string
Date and time the record was created (ISO 8601).
​
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
​
UpdatedBy
string
Email of the user who last updated this record.
​
IsNew
boolean
Whether the record was recently created.
​
SystemId
string
External system identifier.
Example Response
{
  "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
}