Building and floor discovery

Use this query when you need the portfolio skeleton before doing anything else.

Typical use

• Show a building or floor picker.
• Resolve the floorId required by occupancy, sightings, or heatmap queries.
• Fetch floorPlanUrl and scale for overlays and floor-based visualizations.

Query

Open in API Explorer

Example query

query BuildingAndFloorIndex {
  buildings {
    id
    name
    floors(isLive: true) {
      id
      name
      floorPlanUrl
      scale
    }
  }
}

Example response

{
  "data": {
    "buildings": [
      {
        "id": "0b26f8f3-5d1c-4c6a-9d3e-1a2b3c4d5e6f",
        "name": "1 Example Street",
        "floors": [
          {
            "id": "a2961d46-971f-4ce1-a66e-7ee7bdb2a204",
            "name": "Level 12",
            "floorPlanUrl": "https://cdn.xysense.io/floorplans/level-12.png",
            "scale": 1.8
          }
        ]
      }
    ]
  }
}

IDs are GUIDs. Some other guides shorten them to readable slugs (such as desk-ne-101) to keep examples compact.