> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get one FloorPlanLayout

> Retrieve a single FloorPlanLayout record by its Id.

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

<Note>
  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.
</Note>

## Path Parameters

<ParamField path="id" type="integer" required>
  The Id of the FloorPlanLayout record to retrieve.
</ParamField>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/sys/floorplanlayouts/87654321" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/sys/floorplanlayouts/87654321',
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const record = await response.json();
  ```

  ```python Python theme={null}
  import requests

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

  record = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="BusinessId" type="integer">
  ID of the business linked to this record.
</ResponseField>

<ResponseField name="BusinessName" type="string">
  Display name of the linked business (read-only).
</ResponseField>

<ResponseField name="BusinessCurrencyCode" type="string">
  The business currency code value for this floor plan layout.
</ResponseField>

<ResponseField name="Name" type="string">
  The name value for this floor plan layout.
</ResponseField>

<ResponseField name="BackgroundImageFileName" type="string">
  Current file name of the background image (read-only; upload via the corresponding URL field).
</ResponseField>

<ResponseField name="NewBackgroundImageUrl" type="string">
  URL of a new file to upload as the background image.
</ResponseField>

<ResponseField name="ClearBackgroundImageFile" type="boolean">
  Set to true to remove the current background image file.
</ResponseField>

<ResponseField name="Size" type="number">
  The size value for this floor plan layout.
</ResponseField>

<ResponseField name="TracingImageFileName" type="string">
  Current file name of the tracing image (read-only; upload via the corresponding URL field).
</ResponseField>

<ResponseField name="NewTracingImageUrl" type="string">
  URL of a new file to upload as the tracing image.
</ResponseField>

<ResponseField name="ClearTracingImageFile" type="boolean">
  Set to true to remove the current tracing image file.
</ResponseField>

<ResponseField name="PreviewImageFileName" type="string">
  Current file name of the preview image (read-only; upload via the corresponding URL field).
</ResponseField>

<ResponseField name="NewPreviewImageUrl" type="string">
  URL of a new file to upload as the preview image.
</ResponseField>

<ResponseField name="ClearPreviewImageFile" type="boolean">
  Set to true to remove the current preview image file.
</ResponseField>

<ResponseField name="BackgroundImageScale" type="integer">
  The background image scale value for this floor plan layout.
</ResponseField>

<ResponseField name="TracingImageScale" type="integer">
  The tracing image scale value for this floor plan layout.
</ResponseField>

<ResponseField name="FloorLevel" type="integer">
  The floor level value for this floor plan layout.
</ResponseField>

<ResponseField name="Id" type="integer">
  Unique record identifier.
</ResponseField>

<ResponseField name="UniqueId" type="string">
  UUID of the record.
</ResponseField>

<ResponseField name="CreatedOn" type="string">
  Date and time the record was created (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedOn" type="string">
  Date and time the record was last updated (ISO 8601).
</ResponseField>

<ResponseField name="UpdatedBy" type="string">
  Email of the user who last updated this record.
</ResponseField>

<ResponseField name="IsNew" type="boolean">
  Whether the record was recently created.
</ResponseField>

<ResponseField name="SystemId" type="string">
  External system identifier.
</ResponseField>

```json Example Response theme={null}
{
  "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
}
```