Skip to main content
GET
/
api
/
sys
/
floorplanlayoutareas
/
{id}
Get one FloorPlanLayoutArea
curl --request GET \
  --url https://spaces.nexudus.com/api/sys/floorplanlayoutareas/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "FloorPlanLayoutId": 123,
  "FloorPlanLayoutName": "<string>",
  "Name": "<string>",
  "ContainedAreas": "<string>",
  "Nodes": "<string>",
  "Size": 123,
  "Color": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}
A FloorPlanLayoutArea defines a named region within a floor plan layout, such as a zone, room, or section. Areas help organize and group desks and assets within the floor plan.

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

​
Path Parameters

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

​
Code Examples

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

​
Response

​
200

​
FloorPlanLayoutId
integer
ID of the floor plan layout linked to this record.
​
FloorPlanLayoutName
string
Display name of the linked floor plan layout (read-only).
​
Name
string
The name value for this floor plan layout area.
​
ContainedAreas
string
The contained areas value for this floor plan layout area.
​
Nodes
string
The nodes value for this floor plan layout area.
​
Size
number
The size value for this floor plan layout area.
​
Color
string
The color value for this floor plan layout area.
​
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
{
  "FloorPlanLayoutId": 0,
  "FloorPlanLayoutName": null,
  "Name": "",
  "ContainedAreas": null,
  "Nodes": null,
  "Size": 0,
  "Color": 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": "FloorPlanLayoutArea Example",
  "LocalizationDetails": null,
  "CustomFields": null
}