Skip to main content
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>'
{
  "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 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-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
ID of the location this floor plan belongs to.
​
BusinessName
string
Location name.
​
BusinessCurrencyCode
string
Currency code of the location.
​
FloorPlanLayoutId
integer
ID of the floor plan layout template to apply to this floor plan.
​
FloorPlanLayoutName
string
Floor plan layout name.
​
Name
string
Display name of the floor plan (e.g. ‘Ground Floor’, ‘Level 2’).
​
BackgroundImageFileName
string
Filename of the currently stored background/tracing image.
​
NewBackgroundImageUrl
string
URL of a new background/tracing image to upload. The image will be fetched and stored when the floor plan is saved.
​
ClearBackgroundImageFile
boolean
Set to true to remove the current background/tracing image from this floor plan.
​
DisplayBackground
boolean
Whether the background/tracing image is visible when the floor plan is rendered.
​
BackgroundScale
integer
Zoom/scale factor applied to the background/tracing image, expressed as a percentage (e.g. 100 = original size).
​
PositionX
integer
Horizontal offset (in pixels) of the background image within the floor plan canvas.
​
PositionY
integer
Vertical offset (in pixels) of the background image within the floor plan canvas.
​
FloorLevel
integer
Floor number used to order floor plans (e.g. 0 = ground floor, 1 = first floor, -1 = basement).
​
Scale
number
Real-world scale of the floor plan, representing how many real-world units correspond to one canvas unit.
​
Capacity
integer
Maximum number of people this floor can accommodate at the same time.
​
ArchilogicUniqueId
string
Unique identifier used to link this floor plan to a corresponding Archilogic 3D model.
​
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
}