Novant

Documentation

Spaces

Retrieves a list of all spaces in this project.

POST /v1/spaces
curl https://api.novant.io/v1/spaces \
  -X POST \
  -u ak_sample_123: \
  --compressed

Parameters

space_ids

An allowlist to filter spaces. Ids are formatted as a comma-separated list, i.e.: "sp.1,sp.2,sp.8".

Returns

Returns the list of spaces in this project. If space_ids was specified, only returns selected spaces.

{
  "spaces": [
    {
      "id": "sp.1",
      "name": "Headquarters",
      "type": "building",
      "props": {
        "street_address": "101 Crawfords Corner Rd",
        "floor_area": "150000 ft²"
      },
      "ontology": {
        "brick": "Building",
        "haystack": "site"
      }
    },
    {
      "id": "sp.2",
      "name": "Floor 3",
      "type": "floor",
      "parent_space_id": "sp.1",
      "props": {},
      "ontology": {
        "brick": "Floor",
        "haystack": "floor"
      }
    },
    {
      "id": "sp.4",
      "name": "Room 302",
      "type": "room",
      "parent_space_id": "sp.2",
      "parent_zone_id": "z.1",
      "contains_asset_ids": [
        "a.1"
      ],
      "props": {},
      "ontology": {
        "brick": "Room",
        "haystack": "room"
      }
    },
    ...
  ]
}