Open Inventory / Docs
EndpointsSpatial roomsSpatial structures

List buildings and their active indoor-scan coverage

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

Authorization

bearerAuth
headerAuthorizationBearer <inv_ token>

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

Structures with active room, floor, coordinate-space, and compatible-bounds counts

application/json
  1. response
structures*array<>
Example Request
curl -X GET 'https://inventory.example.com/api/v1/spatial-structures'
Example Response200
{  "structures": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "description": "string",      "georeference": {        "latitude": -90,        "longitude": -180,        "altitude": -12000,        "headingDegrees": 0,        "horizontalAccuracy": 0,        "verticalAccuracy": 0,        "capturedAt": "2019-08-24T14:15:22Z",        "source": "gps",        "localReferencePosition": [          0,          0,          0        ],        "referencePoints": [          {            "id": "string",            "label": "string",            "localPosition": [              -10000,              -10000,              -10000            ],            "latitude": -90,            "longitude": -180,            "altitude": -12000          }        ],        "entryMarkerCode": "string"      },      "floorCount": 0,      "roomCount": 0,      "activeScanCount": 0,      "coordinateSpaceCount": 0,      "bounds": {        "min": [          -10000,          -10000,          -10000        ],        "max": [          -10000,          -10000,          -10000        ]      },      "boundsCoordinateSpaceId": "0145cfc3-84b8-499e-b434-12a47e254a2d",      "boundsGeoreference": {        "latitude": -90,        "longitude": -180,        "altitude": -12000,        "headingDegrees": 0,        "horizontalAccuracy": 0,        "verticalAccuracy": 0,        "capturedAt": "2019-08-24T14:15:22Z",        "source": "gps",        "localReferencePosition": [          0,          0,          0        ],        "referencePoints": [          {            "id": "string",            "label": "string",            "localPosition": [              -10000,              -10000,              -10000            ],            "latitude": -90,            "longitude": -180,            "altitude": -12000          }        ],        "entryMarkerCode": "string"      },      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ]}

Create or replace an item's current indoor 3D placement PUT

The scan must still be the active revision. Coordinates use its ARKit world frame in metres.

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.