gospace AIDocsAdmin Console

Spatial API

get

Retrieve a list of locations or a specific location by ID.

Authorizations
Query parameters
location_idstringOptional

Optional ID of the location to retrieve.

external_idstringOptional

Optional external ID of the location to retrieve.

skipintegerOptional

Number of items to skip.

Default: 0
limitintegerOptional

Maximum number of items to return.

Default: 25
sortstringOptional

Field by which to sort.

orderstring · enumOptional

Sort order, 'asc' or 'desc'.

Possible values:
Responses
200

OK

application/json
get
GET /spatial/v1/locations HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "data": {
    "locations": [
      {
        "_id": "688227c3dace846b3e224125",
        "name": "London Office",
        "country": {
          "selected_timezone": "Europe/London",
          "country_id": "67581d8121c115b2ae8c940c",
          "iso2": "GB",
          "name": "United Kingdom",
          "timezones": [
            "Europe/London"
          ]
        },
        "address": {
          "postal_code": "EC2V 6DN",
          "country_name": "United Kingdom",
          "line1": "107 Cheapside",
          "line2": "9th Floor"
        },
        "coords": {
          "latitude": 51.51440243017529,
          "longitude": -0.09350140202932772
        },
        "created_at": "2025-07-24T12:32:03.254Z",
        "updated_at": "2025-07-24T12:32:03.254Z",
        "settings": {
          "consolidation": "NONE",
          "consolidation_mode": "DEFAULT",
          "evolution_settings": {
            "evolution_stops_at": {
              "hour": 0,
              "minute": 0
            },
            "evolution_offset_days": 0,
            "auto_evolve_disabled": true
          },
          "operating_hours": [
            {
              "days": [
                "MONDAY",
                "TUESDAY",
                "WEDNESDAY",
                "THURSDAY",
                "FRIDAY",
                "SATURDAY",
                "SUNDAY"
              ],
              "open": {
                "hour": 0,
                "minute": 0
              },
              "close": {
                "hour": 23,
                "minute": 59
              }
            }
          ],
          "features": {
            "AUTO_ALLOCATE": {
              "enabled": true,
              "feature": "AUTO_ALLOCATE",
              "settings": {
                "allocation_mode": "DEFAULT",
                "auto_schedule": {
                  "auto_schedule_enabled": false,
                  "auto_schedule_percentage": 80,
                  "auto_schedule_future_days": 10,
                  "user_prefs_enabled": true
                },
                "likely_schedule": {
                  "likely_schedule_enabled": false,
                  "likely_schedule_percentage": 50,
                  "likely_schedule_future_days": 10,
                  "user_prefs_enabled": true
                },
                "fixed_schedule": {
                  "fixed_schedule_enabled": false,
                  "fixed_schedule_days": 3,
                  "fixed_schedule_future_days": 10
                }
              }
            },
            "CUSTOM_TEAMS": {
              "enabled": false,
              "feature": "CUSTOM_TEAMS"
            },
            "INVITES": {
              "enabled": false,
              "feature": "INVITES"
            },
            "SCHEDULE_SPACE": {
              "enabled": true,
              "feature": "SCHEDULE_SPACE"
            },
            "SCHEDULE_ROOMS": {
              "enabled": false,
              "feature": "SCHEDULE_ROOMS"
            },
            "SCHEDULE_MEETINGS": {
              "enabled": false,
              "feature": "SCHEDULE_MEETINGS"
            }
          }
        },
        "external_id": "loc-1",
        "location_id": "688227c3dace846b3e224125"
      }
    ],
    "pagination": {
      "current_results": {
        "from": 0,
        "to": 25
      },
      "total_results": 1
    }
  },
  "identifier": "get_locations_successful"
}
post

Create multiple locations.

Authorizations
Body
Responses
201

Created

application/json
post
POST /spatial/v1/locations HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1293

{
  "locations": [
    {
      "name": "text",
      "country": {
        "country_id": "text",
        "name": "text",
        "selected_timezone": "text",
        "iso2": "text",
        "timezones": [
          "text"
        ]
      },
      "address": {
        "postal_code": "text",
        "country_name": "text",
        "line1": "text",
        "line2": "text"
      },
      "coords": {
        "latitude": 1,
        "longitude": 1
      },
      "external_id": "text",
      "settings": {
        "consolidation": "NONE",
        "consolidation_mode": "DEFAULT",
        "evolution_settings": {
          "evolution_stops_at": {
            "hour": 1,
            "minute": 1
          },
          "evolution_offset_days": 1,
          "auto_evolve_disabled": true
        },
        "operating_hours": [
          {
            "days": [
              "text"
            ],
            "open": {
              "hour": 1,
              "minute": 1
            },
            "close": {
              "hour": 1,
              "minute": 1
            }
          }
        ],
        "features": {
          "AUTO_ALLOCATE": {
            "enabled": true,
            "feature": "text",
            "settings": {
              "allocation_mode": "text",
              "auto_schedule": {
                "auto_schedule_enabled": true,
                "auto_schedule_percentage": 1,
                "auto_schedule_future_days": 1,
                "user_prefs_enabled": true
              },
              "likely_schedule": {
                "likely_schedule_enabled": true,
                "likely_schedule_percentage": 1,
                "likely_schedule_future_days": 1,
                "user_prefs_enabled": true
              },
              "fixed_schedule": {
                "fixed_schedule_enabled": true,
                "fixed_schedule_days": 1,
                "fixed_schedule_future_days": 1
              }
            }
          },
          "CUSTOM_TEAMS": {
            "enabled": true,
            "feature": "text"
          },
          "INVITES": {
            "enabled": true,
            "feature": "text"
          },
          "SCHEDULE_SPACE": {
            "enabled": true,
            "feature": "text"
          },
          "SCHEDULE_ROOMS": {
            "enabled": true,
            "feature": "text"
          },
          "SCHEDULE_MEETINGS": {
            "enabled": true,
            "feature": "text"
          }
        }
      }
    }
  ]
}
{
  "success": true,
  "data": {
    "locations": [
      {
        "_id": "688227c3dace846b3e224125",
        "name": "London Office",
        "country": {
          "selected_timezone": "Europe/London",
          "country_id": "67581d8121c115b2ae8c940c",
          "iso2": "GB",
          "name": "United Kingdom",
          "timezones": [
            "Europe/London"
          ]
        },
        "address": {
          "postal_code": "EC2V 6DN",
          "country_name": "United Kingdom",
          "line1": "107 Cheapside",
          "line2": "9th Floor"
        },
        "coords": {
          "latitude": 51.51440243017529,
          "longitude": -0.09350140202932772
        },
        "created_at": "2025-07-24T12:32:03.254Z",
        "updated_at": "2025-07-24T12:32:03.254Z",
        "settings": {
          "consolidation": "NONE",
          "consolidation_mode": "DEFAULT",
          "evolution_settings": {
            "evolution_stops_at": {
              "hour": 0,
              "minute": 0
            },
            "evolution_offset_days": 0,
            "auto_evolve_disabled": true
          },
          "operating_hours": [
            {
              "days": [
                "MONDAY",
                "TUESDAY",
                "WEDNESDAY",
                "THURSDAY",
                "FRIDAY",
                "SATURDAY",
                "SUNDAY"
              ],
              "open": {
                "hour": 0,
                "minute": 0
              },
              "close": {
                "hour": 23,
                "minute": 59
              }
            }
          ],
          "features": {
            "AUTO_ALLOCATE": {
              "enabled": true,
              "feature": "AUTO_ALLOCATE",
              "settings": {
                "allocation_mode": "DEFAULT",
                "auto_schedule": {
                  "auto_schedule_enabled": false,
                  "auto_schedule_percentage": 80,
                  "auto_schedule_future_days": 10,
                  "user_prefs_enabled": true
                },
                "likely_schedule": {
                  "likely_schedule_enabled": false,
                  "likely_schedule_percentage": 50,
                  "likely_schedule_future_days": 10,
                  "user_prefs_enabled": true
                },
                "fixed_schedule": {
                  "fixed_schedule_enabled": false,
                  "fixed_schedule_days": 3,
                  "fixed_schedule_future_days": 10
                }
              }
            },
            "CUSTOM_TEAMS": {
              "enabled": false,
              "feature": "CUSTOM_TEAMS"
            },
            "INVITES": {
              "enabled": false,
              "feature": "INVITES"
            },
            "SCHEDULE_SPACE": {
              "enabled": true,
              "feature": "SCHEDULE_SPACE"
            },
            "SCHEDULE_ROOMS": {
              "enabled": false,
              "feature": "SCHEDULE_ROOMS"
            },
            "SCHEDULE_MEETINGS": {
              "enabled": false,
              "feature": "SCHEDULE_MEETINGS"
            }
          }
        },
        "external_id": "loc-1",
        "location_id": "688227c3dace846b3e224125"
      }
    ]
  },
  "identifier": "create_locations_successful"
}
put

Update multiple locations.

Authorizations
Bodyobject[]
location_idstringRequired

ID of the location to update.

namestringOptional

Name of the location.

descriptionstringOptional

Description of the location.

Responses
200

OK

application/json
put
PUT /spatial/v1/locations HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 59

[
  {
    "location_id": "text",
    "name": "text",
    "description": "text"
  }
]
{
  "success": true,
  "data": {
    "locations": [
      {
        "location_id": "loc_123"
      },
      {
        "location_id": "loc_124"
      }
    ]
  },
  "identifier": "update_locations_successful"
}
delete

Delete multiple locations by IDs.

Authorizations
Body
Responses
200

Deleted

application/json
delete
DELETE /spatial/v1/locations HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "locations": [
    {
      "location_id": "text"
    }
  ]
}
{
  "success": true,
  "data": [
    {
      "location_id": "688227c3dace846b3e224125"
    }
  ],
  "identifier": "delete_locations_successful"
}
get

Retrieve layers within a location, optionally filtered by layer ID.

Authorizations
Query parameters
location_idstringOptional

ID of the location to retrieve layers from.

layer_idstringOptional

Optional ID of the layer to retrieve.

external_idstringOptional

Optional external ID of the layer to retrieve.

skipintegerOptional

Number of items to skip.

Default: 0
limitintegerOptional

Maximum number of items to return.

Default: 25
sortstringOptional

Field by which to sort.

orderstring · enumOptional

Sort order, 'asc' or 'desc'.

Possible values:
geojsonbooleanOptional

Return geometries in GeoJSON format.

Default: false
imdfbooleanOptional

Return geometries in IMDF format.

Default: false
Responses
200

OK

application/json
get
GET /spatial/v1/layers HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "data": {
    "layers": [
      {
        "_id": "68826684f9ba20a033c00de3",
        "name": "Floor 1",
        "type": "FLOOR",
        "location_id": "68824ca5369c856b7c670510",
        "created_at": "2025-07-24T16:59:48.901Z",
        "updated_at": "2025-07-24T16:59:48.901Z",
        "floor_plan_entities": [
          {
            "geometry": "POLYGON((-5849.2558016537705 -11141.51491426587, 16965.55832469468 -11141.51491426587, 16965.55832469468 5249.595323199746, -5849.2558016537705 5249.595323199746, -5849.2558016537705 -11141.51491426587, -5849.2558016537705 -11141.51491426587))",
            "type": "WALL_PERIMETER"
          }
        ],
        "settings": {
          "level": 0,
          "freeze": false,
          "consolidation": "NONE",
          "consolidation_mode": "DEFAULT",
          "scale": 1,
          "units": "mm"
        },
        "external_id": "floor-1"
      }
    ],
    "pagination": {
      "current_results": {
        "from": 0,
        "to": 25
      },
      "total_results": 1
    }
  },
  "identifier": "get_layers_successful"
}
post

Create multiple layers.

Authorizations
Body
Responses
201

Created

application/json
post
POST /spatial/v1/layers HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 152

{
  "layers": [
    {
      "location_id": "text",
      "name": "text",
      "type": "text",
      "external_id": "text",
      "floor_plan_entities": [
        {
          "geometry": "text",
          "type": "WALL_PERIMETER"
        }
      ]
    }
  ]
}
{
  "success": true,
  "data": [
    {
      "_id": "68826684f9ba20a033c00de3",
      "name": "Floor 1",
      "type": "FLOOR",
      "location_id": "68824ca5369c856b7c670510",
      "created_at": "2025-07-24T16:59:48.901Z",
      "updated_at": "2025-07-24T16:59:48.901Z",
      "floor_plan_entities": [
        {
          "geometry": "POLYGON((-5849.2558016537705 -11141.51491426587, 16965.55832469468 -11141.51491426587, 16965.55832469468 5249.595323199746, -5849.2558016537705 5249.595323199746, -5849.2558016537705 -11141.51491426587, -5849.2558016537705 -11141.51491426587))",
          "type": "WALL_PERIMETER"
        }
      ],
      "settings": {
        "level": 0,
        "freeze": false,
        "consolidation": "NONE",
        "consolidation_mode": "DEFAULT",
        "scale": 1,
        "units": "mm"
      },
      "external_id": "floor-1"
    }
  ],
  "identifier": "create_layers_successful"
}
put

Update multiple layers.

Authorizations
Bodyobject[]
layer_idstringRequired

ID of the layer to update.

namestringOptional

Name of the layer.

Responses
200

OK

application/json
put
PUT /spatial/v1/layers HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 35

[
  {
    "layer_id": "text",
    "name": "text"
  }
]
{
  "success": true,
  "data": {
    "layers": [
      {
        "layer_id": "layer_123"
      },
      {
        "layer_id": "layer_124"
      }
    ]
  },
  "identifier": "update_layers_successful"
}
delete

Delete multiple layers by IDs.

Authorizations
Body
Responses
200

Deleted

application/json
delete
DELETE /spatial/v1/layers HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "layers": [
    {
      "layer_id": "text"
    }
  ]
}
{
  "success": true,
  "data": [
    {
      "layer_id": "layer_123"
    },
    {
      "layer_id": "layer_124"
    }
  ],
  "identifier": "delete_layers_successful"
}
get

Retrieve spaces within a location or layer, optionally filtered by space ID or external ID.

Authorizations
Query parameters
location_idstringOptional

ID of the location to retrieve spaces from.

layer_idstringOptional

ID of the layer to retrieve spaces from.

space_idstringOptional

Optional ID of the space to retrieve.

external_idstringOptional

Optional external ID of the space to retrieve.

skipintegerOptional

Number of items to skip.

Default: 0
limitintegerOptional

Maximum number of items to return.

Default: 25
sortstringOptional

Field by which to sort.

orderstring · enumOptional

Sort order, 'asc' or 'desc'.

Possible values:
geojsonbooleanOptional

Return geometries in GeoJSON format.

Default: false
imdfbooleanOptional

Return geometries in IMDF format.

Default: false
Responses
200

OK

application/json
get
GET /spatial/v1/spaces HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "data": {
    "spaces": [
      {
        "_id": "6887a6ac796ce0b61678ea8d",
        "settings": {
          "enabled": true,
          "flex": false,
          "freeze": false,
          "consolidated": false,
          "consolidation_anchor": false,
          "fixed_people": [],
          "fixed_teams": []
        },
        "location_id": "68824ca5369c856b7c670510",
        "layer_id": "6887a692adf46f55a397e82d",
        "created_at": "2025-07-28T16:34:52.586Z",
        "updated_at": "2025-07-29T12:55:02.818Z",
        "space_id": "6887a6ac796ce0b61678ea8d",
        "position": {
          "center": {
            "x": -2046.7867805956953,
            "y": -7043.737354899466
          },
          "geometry_mutations": {
            "enable_mutations": false,
            "angle": 0,
            "wkt": "POLYGON((-5088.761990842155 -10631.959402392589, 995.1884296507645 -10631.959402392589, 995.1884296507645 -3455.515307406342, -5088.761990842155 -3455.515307406342, -5088.761990842155 -10631.959402392589))",
            "geometry_type": "Rectangle",
            "size": {
              "height": 7176.444106859529,
              "width": 6844.444237904535
            }
          }
        },
        "external_id": "desk-1"
      }
    ],
    "pagination": {
      "current_results": {
        "from": 0,
        "to": 25
      },
      "total_results": 1
    }
  },
  "identifier": "get_spaces_successful"
}
post

Create multiple spaces.

Authorizations
Body
Responses
201

Created

application/json
post
POST /spatial/v1/spaces HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 231

{
  "data": [
    {
      "location_id": "text",
      "layer_id": "text",
      "position": {
        "center": {
          "x": 1,
          "y": 1
        },
        "geometry_mutations": {
          "enable_mutations": true,
          "angle": 1,
          "wkt": "text",
          "geometry_type": "text",
          "size": {
            "height": 1,
            "width": 1
          }
        }
      },
      "external_id": "text"
    }
  ]
}
{
  "success": true,
  "data": {
    "spaces": [
      {
        "_id": "6887a6ac796ce0b61678ea8d",
        "settings": {
          "enabled": true,
          "flex": false,
          "freeze": false,
          "consolidated": false,
          "consolidation_anchor": false,
          "fixed_people": [],
          "fixed_teams": []
        },
        "location_id": "68824ca5369c856b7c670510",
        "layer_id": "6887a692adf46f55a397e82d",
        "created_at": "2025-07-28T16:34:52.586Z",
        "updated_at": "2025-07-29T12:55:02.818Z",
        "space_id": "6887a6ac796ce0b61678ea8d",
        "position": {
          "center": {
            "x": -2046.7867805956953,
            "y": -7043.737354899466
          },
          "geometry_mutations": {
            "enable_mutations": false,
            "angle": 0,
            "wkt": "POLYGON((-5088.761990842155 -10631.959402392589, 995.1884296507645 -10631.959402392589, 995.1884296507645 -3455.515307406342, -5088.761990842155 -3455.515307406342, -5088.761990842155 -10631.959402392589))",
            "geometry_type": "Rectangle",
            "size": {
              "height": 7176.444106859529,
              "width": 6844.444237904535
            }
          }
        },
        "external_id": "desk-1"
      }
    ]
  },
  "identifier": "create_spaces_successful"
}
put

Update multiple spaces.

Authorizations
Body
Responses
200

OK

application/json
put
PUT /spatial/v1/spaces HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 191

{
  "spaces": [
    {
      "space_id": "text",
      "position": {
        "center": {
          "x": 1,
          "y": 1
        },
        "geometry_mutations": {
          "enable_mutations": true,
          "angle": 1,
          "wkt": "text",
          "geometry_type": "text",
          "size": {
            "height": 1,
            "width": 1
          }
        }
      }
    }
  ]
}
{
  "success": true,
  "data": [
    {
      "_id": "688798fcf37795e32d5feacf",
      "space_id": "688798fcf37795e32d5feacf",
      "position": {
        "center": {
          "x": -2046.7867805956953,
          "y": -7043.737354899466
        },
        "geometry_mutations": {
          "enable_mutations": false,
          "angle": 0,
          "wkt": "POLYGON((-5088.761990842155 -10631.959402392589, 995.1884296507645 -10631.959402392589, 995.1884296507645 -3455.515307406342, -5088.761990842155 -3455.515307406342, -5088.761990842155 -10631.959402392589))",
          "geometry_type": "Rectangle",
          "size": {
            "height": 7176.444106859529,
            "width": 6844.444237904535
          }
        }
      }
    }
  ],
  "identifier": "update_spaces_successful"
}
delete

Delete multiple spaces by IDs.

Authorizations
Body
Responses
200

Deleted

application/json
delete
DELETE /spatial/v1/spaces HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "spaces": [
    {
      "space_id": "text"
    }
  ]
}
{
  "success": true,
  "data": [
    {
      "_id": "6888c125452e7ca555a51078"
    }
  ],
  "identifier": "delete_spaces_successful"
}
get

Retrieve rooms within a location or layer, optionally filtered by room ID or external ID.

Authorizations
Query parameters
location_idstringOptional

ID of the location to retrieve rooms from.

layer_idstringOptional

ID of the layer to retrieve rooms from.

room_idstringOptional

Optional ID of the room to retrieve.

external_idstringOptional

Optional external ID of the room to retrieve.

skipintegerOptional

Number of items to skip.

Default: 0
limitintegerOptional

Maximum number of items to return.

Default: 25
sortstringOptional

Field by which to sort.

orderstring · enumOptional

Sort order, 'asc' or 'desc'.

Possible values:
geojsonbooleanOptional

Return geometries in GeoJSON format.

Default: false
imdfbooleanOptional

Return geometries in IMDF format.

Default: false
Responses
200

OK

application/json
get
GET /spatial/v1/rooms HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "data": {
    "rooms": [
      {
        "_id": "6888c290c0766754c23cc885",
        "room_id": "6888c290c0766754c23cc885",
        "name": "Room 2",
        "settings": {
          "capacity": 0,
          "scheduling": {
            "enabled": true
          },
          "consolidation": "NONE",
          "consolidation_mode": "DEFAULT"
        },
        "type": "MEETING",
        "location_id": "68824ca5369c856b7c670510",
        "layer_id": "6887a692adf46f55a397e82d",
        "created_at": "2025-07-29T12:46:08.283Z",
        "updated_at": "2025-07-29T12:46:08.283Z",
        "geometry": "POLYGON((-5849.2558016537705 -11141.51491426587, 1755.68224046238 -11141.51491426587, 1755.68224046238 -2945.959795533061, -5849.2558016537705 -2945.959795533061, -5849.2558016537705 -11141.51491426587))",
        "spaces": [
          "6887a6ac796ce0b61678ea91"
        ],
        "external_id": "room-2"
      }
    ],
    "pagination": {
      "current_results": {
        "from": 0,
        "to": 25
      },
      "total_results": 1
    }
  },
  "identifier": "get_rooms_successful"
}
post

Create multiple rooms.

Authorizations
Body
Responses
201

Created

application/json
post
POST /spatial/v1/rooms HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 140

{
  "rooms": [
    {
      "name": "text",
      "type": "MEETING",
      "location_id": "text",
      "layer_id": "text",
      "geometry": "text",
      "external_id": "text",
      "spaces": [
        "text"
      ]
    }
  ]
}
{
  "success": true,
  "data": [
    {
      "_id": "6888c290c0766754c23cc885",
      "name": "Room 2",
      "settings": {
        "capacity": 0,
        "scheduling": {
          "enabled": true
        },
        "consolidation": "NONE",
        "consolidation_mode": "DEFAULT"
      },
      "type": "MEETING",
      "location_id": "68824ca5369c856b7c670510",
      "layer_id": "6887a692adf46f55a397e82d",
      "created_at": "2025-07-29T12:46:08.283Z",
      "updated_at": "2025-07-29T12:46:08.283Z",
      "geometry": "POLYGON((-5849.2558016537705 -11141.51491426587, 1755.68224046238 -11141.51491426587, 1755.68224046238 -2945.959795533061, -5849.2558016537705 -2945.959795533061, -5849.2558016537705 -11141.51491426587))",
      "spaces": [
        "6887a6ac796ce0b61678ea91"
      ],
      "external_id": "room-2"
    }
  ],
  "identifier": "create_rooms_successful"
}
put

Update multiple rooms.

Authorizations
Body
Responses
200

OK

application/json
put
PUT /spatial/v1/rooms HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "rooms": [
    {
      "room_id": "text",
      "spaces": [
        "text"
      ]
    }
  ]
}
{
  "success": true,
  "data": [
    {
      "_id": "6888c290c0766754c23cc885",
      "room_id": "6888c290c0766754c23cc885",
      "spaces": [
        "6887a6ac796ce0b61678ea8d"
      ]
    }
  ],
  "identifier": "update_rooms_successful"
}
delete

Delete multiple rooms by IDs.

Authorizations
Body
Responses
200

Deleted

application/json
delete
DELETE /spatial/v1/rooms HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "rooms": [
    {
      "room_id": "text"
    }
  ]
}
{
  "success": true,
  "data": [
    {
      "room_id": "6888c125452e7ca555a51078"
    }
  ],
  "identifier": "delete_rooms_successful"
}
get

Retrieve zones within a location or layer, optionally filtered by zone ID or external ID.

Authorizations
Query parameters
location_idstringOptional

ID of the location to retrieve zones from.

layer_idstringOptional

ID of the layer to retrieve zones from.

zone_idstringOptional

Optional ID of the zone to retrieve.

external_idstringOptional

Optional external ID of the zone to retrieve.

skipintegerOptional

Number of items to skip.

Default: 0
limitintegerOptional

Maximum number of items to return.

Default: 25
sortstringOptional

Field by which to sort.

orderstring · enumOptional

Sort order, 'asc' or 'desc'.

Possible values:
Responses
200

OK

application/json
get
GET /spatial/v1/zones HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "data": {
    "zones": [
      {
        "_id": "688a0f5adfab6fca2d27e4ae",
        "zone_id": "688a0f5adfab6fca2d27e4ae",
        "name": "Zone A",
        "settings": {
          "capacity": 0,
          "consolidation": "NONE",
          "consolidation_mode": "DEFAULT",
          "color": "#40bd32"
        },
        "spaces": [
          "6887a6ac796ce0b61678ea92",
          "6887a6ac796ce0b61678ea90",
          "6887a6ac796ce0b61678ea91",
          "6887a6ac796ce0b61678ea8e"
        ],
        "location_id": "68824ca5369c856b7c670510",
        "layer_id": "6887a692adf46f55a397e82d",
        "created_at": "2025-07-30T12:26:02.464Z",
        "updated_at": "2025-07-30T12:37:47.510Z",
        "external_id": "zone-a"
      }
    ],
    "pagination": {
      "current_results": {
        "from": 0,
        "to": 25
      },
      "total_results": 1
    }
  },
  "identifier": "get_zones_successful"
}
post

Create multiple zones.

Authorizations
Body
Responses
201

Created

application/json
post
POST /spatial/v1/zones HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 105

{
  "zones": [
    {
      "name": "text",
      "location_id": "text",
      "layer_id": "text",
      "spaces": [
        "text"
      ],
      "external_id": "text"
    }
  ]
}
{
  "success": true,
  "data": [
    {
      "_id": "688a0f5adfab6fca2d27e4ae",
      "zone_id": "688a0f5adfab6fca2d27e4ae",
      "name": "Zone A",
      "settings": {
        "capacity": 0,
        "consolidation": "NONE",
        "consolidation_mode": "DEFAULT",
        "color": "#40bd32"
      },
      "spaces": [
        "6887a6ac796ce0b61678ea92",
        "6887a6ac796ce0b61678ea90",
        "6887a6ac796ce0b61678ea91",
        "6887a6ac796ce0b61678ea8e",
        "6887a6ac796ce0b61678ea8d",
        "6887a6ac796ce0b61678ea8f"
      ],
      "location_id": "68824ca5369c856b7c670510",
      "layer_id": "6887a692adf46f55a397e82d",
      "created_at": "2025-07-30T12:26:02.464Z",
      "updated_at": "2025-07-30T12:26:02.464Z",
      "external_id": "zone-a"
    }
  ],
  "identifier": "create_zones_successful"
}
put

Update multiple zones.

Authorizations
Body
Responses
200

OK

application/json
put
PUT /spatial/v1/zones HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "zones": [
    {
      "zone_id": "text",
      "spaces": [
        "text"
      ]
    }
  ]
}
{
  "success": true,
  "data": [
    {
      "_id": "688a0f5adfab6fca2d27e4ae",
      "zone_id": "688a0f5adfab6fca2d27e4ae",
      "spaces": [
        "6887a6ac796ce0b61678ea92",
        "6887a6ac796ce0b61678ea90",
        "6887a6ac796ce0b61678ea91",
        "6887a6ac796ce0b61678ea8e"
      ]
    }
  ],
  "identifier": "update_zones_successful"
}
delete

Delete multiple zones by IDs.

Authorizations
Body
Responses
200

Deleted

application/json
delete
DELETE /spatial/v1/zones HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "zones": [
    {
      "zone_id": "text"
    }
  ]
}
{
  "success": true,
  "data": [
    {
      "zone_id": "688a0e4ffd4a7850e39276c4"
    }
  ],
  "identifier": "delete_zones_successful"
}
get

Retrieve clusters within a location or layer, optionally filtered by cluster ID or external ID.

Authorizations
Query parameters
location_idstringOptional

ID of the location to retrieve clusters from.

layer_idstringOptional

ID of the layer to retrieve clusters from.

cluster_idstringOptional

Optional ID of the cluster to retrieve.

external_idstringOptional

Optional external ID of the cluster to retrieve.

skipintegerOptional

Number of items to skip.

Default: 0
limitintegerOptional

Maximum number of items to return.

Default: 25
sortstringOptional

Field by which to sort.

orderstring · enumOptional

Sort order, 'asc' or 'desc'.

Possible values:
Responses
200

OK

application/json
get
GET /spatial/v1/clusters HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "data": {
    "clusters": [
      {
        "_id": "688a13afd21ada87e4638cbc",
        "cluster_id": "688a13afd21ada87e4638cbc",
        "spaces": [
          "6887a6ac796ce0b61678ea92",
          "6887a6ac796ce0b61678ea90",
          "6887a6ac796ce0b61678ea91"
        ],
        "location_id": "68824ca5369c856b7c670510",
        "layer_id": "6887a692adf46f55a397e82d",
        "created_at": "2025-07-30T12:44:31.207Z",
        "updated_at": "2025-07-30T12:44:31.208Z",
        "external_id": "cluster-1"
      }
    ],
    "pagination": {
      "current_results": {
        "from": 0,
        "to": 25
      },
      "total_results": 1
    }
  },
  "identifier": "get_clusters_successful"
}
post

Create multiple clusters.

Authorizations
Body
Responses
201

Created

application/json
post
POST /spatial/v1/clusters HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 94

{
  "clusters": [
    {
      "location_id": "text",
      "layer_id": "text",
      "spaces": [
        "text"
      ],
      "external_id": "text"
    }
  ]
}
{
  "success": true,
  "data": [
    {
      "_id": "688a13afd21ada87e4638cbc",
      "cluster_id": "688a13afd21ada87e4638cbc",
      "spaces": [
        "6887a6ac796ce0b61678ea92",
        "6887a6ac796ce0b61678ea90",
        "6887a6ac796ce0b61678ea91"
      ],
      "location_id": "68824ca5369c856b7c670510",
      "layer_id": "6887a692adf46f55a397e82d",
      "created_at": "2025-07-30T12:44:31.207Z",
      "updated_at": "2025-07-30T12:44:31.208Z",
      "external_id": "cluster-1"
    }
  ],
  "identifier": "create_clusters_successful"
}
put

Update multiple clusters.

Authorizations
Body
Responses
200

OK

application/json
put
PUT /spatial/v1/clusters HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 54

{
  "clusters": [
    {
      "cluster_id": "text",
      "spaces": [
        "text"
      ]
    }
  ]
}
{
  "success": true,
  "data": [
    {
      "_id": "688a13afd21ada87e4638cbc",
      "cluster_id": "688a13afd21ada87e4638cbc",
      "spaces": [
        "6887a6ac796ce0b61678ea92",
        "6887a6ac796ce0b61678ea90"
      ]
    }
  ],
  "identifier": "update_clusters_successful"
}
delete

Delete multiple clusters by IDs.

Authorizations
Body
Responses
200

Deleted

application/json
delete
DELETE /spatial/v1/clusters HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "clusters": [
    {
      "cluster_id": "text"
    }
  ]
}
{
  "success": true,
  "data": [
    {
      "cluster_id": "688a134d1926b26f236c7325"
    }
  ],
  "identifier": "delete_clusters_successful"
}
get

Retrieve areas within a location or layer, optionally filtered by area ID or external ID.

Authorizations
Query parameters
location_idstringOptional

ID of the location to retrieve areas from.

layer_idstringOptional

ID of the layer to retrieve areas from.

area_idstringOptional

Optional ID of the area to retrieve.

external_idstringOptional

Optional external ID of the area to retrieve.

skipintegerOptional

Number of items to skip.

Default: 0
limitintegerOptional

Maximum number of items to return.

Default: 25
sortstringOptional

Field by which to sort.

orderstring · enumOptional

Sort order, 'asc' or 'desc'.

Possible values:
geojsonbooleanOptional

Return geometries in GeoJSON format.

Default: false
imdfbooleanOptional

Return geometries in IMDF format.

Default: false
Responses
200

OK

application/json
get
GET /spatial/v1/areas HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "data": {
    "areas": [
      {
        "_id": "688a1831935744051235e410",
        "area_id": "688a1831935744051235e410",
        "location_id": "68824ca5369c856b7c670510",
        "layer_id": "6887a692adf46f55a397e82d",
        "geometry": "POLYGON((-5849.2558016537705 -11141.51491426587, 1755.68224046238 -11141.51491426587, 1755.68224046238 -2945.959795533061, -5849.2558016537705 -2945.959795533061, -5849.2558016537705 -11141.51491426587))",
        "created_at": "2025-07-30T13:03:45.006Z",
        "updated_at": "2025-07-30T13:03:45.006Z"
      }
    ],
    "pagination": {
      "current_results": {
        "from": 0,
        "to": 25
      },
      "total_results": 1
    }
  },
  "identifier": "get_areas_successful"
}
post

Create multiple areas.

Authorizations
Body
Responses
201

Created

application/json
post
POST /spatial/v1/areas HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 91

{
  "areas": [
    {
      "location_id": "text",
      "layer_id": "text",
      "geometry": "text",
      "external_id": "text"
    }
  ]
}
{
  "success": true,
  "data": [
    {
      "_id": "688a1831935744051235e410",
      "area_id": "688a1831935744051235e410",
      "location_id": "68824ca5369c856b7c670510",
      "layer_id": "6887a692adf46f55a397e82d",
      "geometry": "POLYGON((-5849.2558016537705 -11141.51491426587, 1755.68224046238 -11141.51491426587, 1755.68224046238 -2945.959795533061, -5849.2558016537705 -2945.959795533061, -5849.2558016537705 -11141.51491426587))",
      "created_at": "2025-07-30T13:03:45.006Z",
      "updated_at": "2025-07-30T13:03:45.006Z"
    }
  ],
  "identifier": "create_areas_successful"
}
put

Update multiple areas.

Authorizations
Body
Responses
200

OK

application/json
put
PUT /spatial/v1/areas HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 48

{
  "areas": [
    {
      "area_id": "text",
      "geometry": "text"
    }
  ]
}
{
  "success": true,
  "data": [
    {
      "_id": "688a18b871d152e00ae517db",
      "area_id": "688a18b871d152e00ae517db",
      "geometry": "POLYGON((-5849.2558016537705 -11141.51491426587, 1755.68224046238 -11141.51491426587, 1755.68224046238 -2945.959795533061, -5849.2558016537705 -2945.959795533061, -5849.2558016537705 -11141.51491426587))"
    }
  ],
  "identifier": "update_areas_successful"
}
delete

Delete multiple areas by IDs.

Authorizations
Body
Responses
200

Deleted

application/json
delete
DELETE /spatial/v1/areas HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 30

{
  "areas": [
    {
      "area_id": "text"
    }
  ]
}
{
  "success": true,
  "data": [
    {
      "area_id": "688a1831935744051235e410"
    }
  ],
  "identifier": "delete_areas_successful"
}
get

Retrieve circulation areas within a location or layer, optionally filtered by circulation ID or external ID. Circulation areas represent paths (e.g., hallways) for controlling people traffic on a floorplan.

Authorizations
Query parameters
location_idstringOptional

ID of the location to retrieve circulation areas from.

layer_idstringOptional

ID of the layer to retrieve circulation areas from.

circulation_idstringOptional

Optional ID of the circulation area to retrieve.

external_idstringOptional

Optional external ID of the circulation area to retrieve.

skipintegerOptional

Number of items to skip.

Default: 0
limitintegerOptional

Maximum number of items to return.

Default: 25
sortstringOptional

Field by which to sort.

orderstring · enumOptional

Sort order, 'asc' or 'desc'.

Possible values:
geojsonbooleanOptional

Return geometries in GeoJSON format.

Default: false
imdfbooleanOptional

Return geometries in IMDF format.

Default: false
Responses
200

OK

application/json
get
GET /spatial/v1/layer/circulation HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "data": {
    "circulation": [
      {
        "_id": "688a1831935744051235e410",
        "circulation_id": "688a1831935744051235e410",
        "location_id": "68824ca5369c856b7c670510",
        "layer_id": "6887a692adf46f55a397e82d",
        "geometries": [
          "LINESTRING(-5849.2558016537705 -11141.51491426587, 1755.68224046238 -2945.959795533061)",
          "LINESTRING(-6000.0 -12000.0, 2000.0 -3000.0)"
        ],
        "created_at": "2025-07-30T13:03:45.006Z",
        "updated_at": "2025-07-30T13:03:45.006Z"
      }
    ],
    "pagination": {
      "current_results": {
        "from": 0,
        "to": 25
      },
      "total_results": 1
    }
  },
  "identifier": "get_circulation_successful"
}
post

Create multiple circulation areas.

Authorizations
Body
Responses
201

Created

application/json
post
POST /spatial/v1/layer/circulation HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 101

{
  "circulation": [
    {
      "location_id": "text",
      "layer_id": "text",
      "geometries": [
        "text"
      ],
      "external_id": "text"
    }
  ]
}
{
  "success": true,
  "data": [
    {
      "_id": "688a1831935744051235e410",
      "circulation_id": "688a1831935744051235e410",
      "location_id": "68824ca5369c856b7c670510",
      "layer_id": "6887a692adf46f55a397e82d",
      "geometries": [
        "LINESTRING(-5849.2558016537705 -11141.51491426587, 1755.68224046238 -2945.959795533061)",
        "LINESTRING(-6000.0 -12000.0, 2000.0 -3000.0)"
      ],
      "created_at": "2025-07-30T13:03:45.006Z",
      "updated_at": "2025-07-30T13:03:45.006Z"
    }
  ],
  "identifier": "create_circulation_successful"
}
put

Update multiple circulation areas.

Authorizations
Body
Responses
200

OK

application/json
put
PUT /spatial/v1/layer/circulation HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "circulation": [
    {
      "circulation_id": "text",
      "geometries": [
        "text"
      ]
    }
  ]
}
{
  "success": true,
  "data": [
    {
      "_id": "688a18b871d152e00ae517db",
      "circulation_id": "688a18b871d152e00ae517db",
      "geometries": [
        "LINESTRING(-5849.2558016537705 -11141.51491426587, 1755.68224046238 -2945.959795533061)",
        "LINESTRING(-6000.0 -12000.0, 2000.0 -3000.0)"
      ]
    }
  ],
  "identifier": "update_circulation_successful"
}
delete

Delete multiple circulation areas by IDs.

Authorizations
Body
Responses
200

Deleted

application/json
delete
DELETE /spatial/v1/layer/circulation HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "circulation": [
    {
      "circulation_id": "text"
    }
  ]
}
{
  "success": true,
  "data": [
    {
      "circulation_id": "688a1831935744051235e410"
    }
  ],
  "identifier": "delete_circulation_successful"
}
PreviousAuthentication APINextDirectory API

Last updated

Was this helpful?