---
title: "Get room configuration"
method: GET
path: "/v1/objects/{object-id}/room"
tags: ["Objects"]
---

# Get room configuration

`GET /v1/objects/{object-id}/room`

Return the room configuration (the same shape accepted by the matching PATCH).

This property group applies to Room objects only; requesting it for any other
object class returns 400.

## Path parameters

- `object-id` integer, required

## Response `200`

Room configuration.

- RoomConfig — Room property group. Returned by GET /v1/objects/{id}/room and embedded as `ObjectDetails.room`; accepted by PATCH /v1/objects/{id}/room with merge-patch semantics (omitted fields are left unchanged). All coordinates and dimensions are in millimetres in room-local coordinates.
  - `roomType` 'COMPUTER_ROOM' | 'ELECTRICAL' | 'MECHANICAL' | 'TELECOM' | 'OTHER' — Kind of room.
  - `outline` RoomPoint[] — Room outline as ordered list of vertices of a simple polygon (no holes). Obstructions inside the room are not part of the outline; they are passive elements.
    - `x` integer, required
    - `y` integer, required
  - `area` number — Floor area in square metres, derived from the outline.
  - `height` integer — Room height; 0 means undeclared.
  - `gridOriginX` integer — X coordinate of floor tile grid origin.
  - `gridOriginY` integer — Y coordinate of floor tile grid origin.
  - `gridTileSize` integer — Floor tile size; 0 means no grid.
  - `gridLabels` 'NONE' | 'LETTERS_NUMBERS' | 'NUMBERS_NUMBERS' — Floor tile label scheme (columns x rows).
  - `backgroundImage` string, uuid, nullable — Image library UUID of floor plan backdrop; null means no backdrop (send null to clear).
  - `backgroundScale` integer — Backdrop calibration in micrometres per image pixel.
  - `backgroundX` integer — X offset of the backdrop in room coordinates.
  - `backgroundY` integer — Y offset of the backdrop in room coordinates.
  - `passiveElements` RoomPassiveElement[]
    - `id` integer — Element ID (assigned by the server; ignored on input).
    - `name` string
    - `type` 'COLUMN' | 'WALL' | 'RAMP' | 'STAIRS' | 'DOOR' | 'OTHER' — Element type (default OTHER). Immutable after creation.
    - `x` integer — X coordinate of footprint reference corner.
    - `y` integer — Y coordinate of footprint reference corner.
    - `rotation` integer — Rotation in degrees.
    - `width` integer
    - `depth` integer

## Other responses

- `400` — Property group not applicable to object class.
- `401` — Unauthorized
- `403` — User does not have read access to the object
- `404` — Object with given ID does not exist

## Changes

- **2026-09-21** `2827204d68d9` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/netxms/apis/netxms-api/changes/v1/objects/:object-id/room/get.md)

---

[API](https://skmtc.dev/netxms/apis/netxms-api.md) · [All operations](https://skmtc.dev/netxms/apis/netxms-api/llms.txt) · [OpenAPI document](https://skmtc.dev/netxms/apis/netxms-api/revisions/0209e896a2a0?raw)