Skip to main content
GET
/
api
/
sys
/
floorplans
/
{id}
{
  "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>"
}

​
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

​
id
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"

​
Response

​
200

​
BusinessId
integer
Business Id.
​
BusinessName
string
Business Name.
​
BusinessCurrencyCode
string
Business Currency Code.
​
FloorPlanLayoutId
integer
Floor Plan Layout Id.
​
FloorPlanLayoutName
string
Floor Plan Layout Name.
​
Name
string
Name.
​
BackgroundImageFileName
string
Background Image File Name.
​
NewBackgroundImageUrl
string
New Background Image Url.
​
ClearBackgroundImageFile
boolean
Clear Background Image File.
​
DisplayBackground
boolean
Display Background.
​
BackgroundScale
integer
Background Scale.
​
PositionX
integer
Position X.
​
PositionY
integer
Position Y.
​
FloorLevel
integer
Floor Level.
​
Scale
number
Scale.
​
Capacity
integer
Capacity.
​
ArchilogicUniqueId
string
Archilogic Unique Id.
​
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,
  "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
}