Open Inventory / Docs
EndpointsSpatial roomsSpatial structuresStructureid

Retrieve active rooms grouped by floor and AR coordinate space

The API runs on your application instance. Schemas and field names come directly from the OpenAPI specification. Session-authenticated requests require a session on that instance.

GET
/spatial-structures/{structureId}

Authorization

bearerAuth
headerAuthorizationBearer <inv_ token>

Path Parameters

structureId*string
Formatuuid

Header Parameters

X-Organization-ID?string

Organization membership selected for this request. User-bound credentials may select any active membership; standalone tokens may only repeat their pinned organization ID.

Formatuuid

Response Body

Structure, coordinate spaces, floors, room scenes, and placements

Example Request
curl -X GET 'https://inventory.example.com/api/v1/spatial-structures/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
Empty

Create a building or other multi-room structure POST

Requires write scope. A structure may also be created atomically by the first grouped room-scan upload.

Update a structure's name or canonical map anchor PATCH

Next Page