Spatial API

get

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

Authorizations

ApiKeyAuth

x-api-keystringRequired

Query parameters

location_idstringOptional

external_idstringOptional

skipintegerOptionalDefault: 0

limitintegerOptionalDefault: 25

sortstringOptional

orderstring · enumOptionalDefault: ascPossible values:

Header parameters

x-configuration-idstringOptional

Optional configuration/scenario key. When omitted, the default configuration is used (configuration_id is null).

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

get

/locations

HTTPcURLJavaScriptPython

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

200

OK

{
  "success": true,
  "data": {
    "locations": [
      {
        "_id": "text",
        "location_id": "text",
        "name": "text",
        "details": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "country": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "address": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "coords": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "settings": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "override_settings": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "external_id": "text",
        "created_at": "2026-03-02T22:30:40.233Z",
        "updated_at": "2026-03-02T22:30:40.233Z",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    ]
  },
  "pagination": {
    "current_results": {
      "from": 1,
      "to": 1
    },
    "total_results": 1
  },
  "identifier": "text"
}

post

Create locations.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Header parameters

x-configuration-idstringOptional

Optional configuration/scenario key. When omitted, the default configuration is used (configuration_id is null).

Body

application/json

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

post

/locations

HTTPcURLJavaScriptPython

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

{
  "locations": [
    {
      "name": "text",
      "country": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "address": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "coords": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "external_id": "text",
      "settings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "override_settings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "starts_at": "2026-03-02T22:30:40.233Z",
      "ends_at": "2026-03-02T22:30:40.233Z"
    }
  ]
}

200

OK

{
  "success": true,
  "data": [
    {
      "_id": "text",
      "location_id": "text",
      "name": "text",
      "details": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "country": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "address": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "coords": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "settings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "override_settings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "external_id": "text",
      "created_at": "2026-03-02T22:30:40.233Z",
      "updated_at": "2026-03-02T22:30:40.233Z",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "identifier": "text"
}

put

Update locations.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Header parameters

x-configuration-idstringOptional

Optional configuration/scenario key. When omitted, the default configuration is used (configuration_id is null).

Body

application/json

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

put

/locations

HTTPcURLJavaScriptPython

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

{
  "locations": [
    {
      "location_id": "text",
      "name": "text",
      "country": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "address": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "coords": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "external_id": "text",
      "settings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ]
}

200

OK

{
  "success": true,
  "data": [
    {
      "_id": "text",
      "location_id": "text",
      "name": "text",
      "details": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "country": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "address": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "coords": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "settings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "override_settings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "external_id": "text",
      "created_at": "2026-03-02T22:30:40.233Z",
      "updated_at": "2026-03-02T22:30:40.233Z",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "identifier": "text"
}

delete

Delete locations.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Header parameters

x-configuration-idstringOptional

Optional configuration/scenario key. When omitted, the default configuration is used (configuration_id is null).

Body

application/json

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

delete

/locations

HTTPcURLJavaScriptPython

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"
    }
  ]
}

200

OK

{
  "success": true,
  "data": [
    {
      "location_id": "text"
    }
  ],
  "identifier": "text"
}

get

Retrieve layers with optional filters.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Query parameters

location_idstringOptional

layer_idstringOptional

external_idstringOptional

geojsonbooleanOptionalDefault: false

imdfbooleanOptionalDefault: false

skipintegerOptionalDefault: 0

limitintegerOptionalDefault: 25

sortstringOptional

orderstring · enumOptionalDefault: ascPossible values:

Header parameters

x-configuration-idstringOptional

Optional configuration/scenario key. When omitted, the default configuration is used (configuration_id is null).

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

get

/layers

HTTPcURLJavaScriptPython

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

200

OK

{
  "success": true,
  "data": {
    "layers": [
      {
        "_id": "text",
        "layer_id": "text",
        "name": "text",
        "type": "text",
        "location_id": "text",
        "location_name": "text",
        "floor_plan_entities": [],
        "settings": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "external_id": "text",
        "created_at": "2026-03-02T22:30:40.233Z",
        "updated_at": "2026-03-02T22:30:40.233Z",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    ]
  },
  "pagination": {
    "current_results": {
      "from": 1,
      "to": 1
    },
    "total_results": 1
  },
  "identifier": "text"
}

post

Create layers.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Header parameters

x-configuration-idstringOptional

Optional configuration/scenario key. When omitted, the default configuration is used (configuration_id is null).

Body

application/json

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

post

/layers

HTTPcURLJavaScriptPython

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

{
  "layers": [
    {
      "name": "text",
      "location_id": "text",
      "location_name": "text",
      "type": "text",
      "floor_plan_entities": [],
      "settings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "external_id": "text"
    }
  ]
}

200

OK

{
  "success": true,
  "data": [
    {
      "_id": "text",
      "layer_id": "text",
      "name": "text",
      "type": "text",
      "location_id": "text",
      "location_name": "text",
      "floor_plan_entities": [],
      "settings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "external_id": "text",
      "created_at": "2026-03-02T22:30:40.233Z",
      "updated_at": "2026-03-02T22:30:40.233Z",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "identifier": "text"
}

put

Update layers.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Header parameters

x-configuration-idstringOptional

Optional configuration/scenario key. When omitted, the default configuration is used (configuration_id is null).

Body

application/json

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

put

/layers

HTTPcURLJavaScriptPython

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

{
  "layers": [
    {
      "layer_id": "text",
      "name": "text",
      "type": "text",
      "settings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "floor_plan_entities": [],
      "external_id": "text"
    }
  ]
}

200

OK

{
  "success": true,
  "data": [
    {
      "_id": "text",
      "layer_id": "text",
      "name": "text",
      "type": "text",
      "location_id": "text",
      "location_name": "text",
      "floor_plan_entities": [],
      "settings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "external_id": "text",
      "created_at": "2026-03-02T22:30:40.233Z",
      "updated_at": "2026-03-02T22:30:40.233Z",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "identifier": "text"
}

delete

Delete layers.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Header parameters

x-configuration-idstringOptional

Optional configuration/scenario key. When omitted, the default configuration is used (configuration_id is null).

Body

application/json

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

delete

/layers

HTTPcURLJavaScriptPython

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"
    }
  ]
}

200

OK

{
  "success": true,
  "data": [
    {
      "layer_id": "text"
    }
  ],
  "identifier": "text"
}

get

Retrieve spaces with optional filters.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Query parameters

location_idstringOptional

layer_idstringOptional

space_idstringOptional

external_idstringOptional

geojsonbooleanOptionalDefault: false

imdfbooleanOptionalDefault: false

skipintegerOptionalDefault: 0

limitintegerOptionalDefault: 25

sortstringOptional

orderstring · enumOptionalDefault: ascPossible values:

Header parameters

x-configuration-idstringOptional

Optional configuration/scenario key. When omitted, the default configuration is used (configuration_id is null).

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

get

/spaces

HTTPcURLJavaScriptPython

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

200

OK

{
  "success": true,
  "data": {
    "spaces": [
      {
        "_id": "text",
        "space_id": "text",
        "name": "text",
        "settings": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "position": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "location_id": "text",
        "location_name": "text",
        "layer_id": "text",
        "layer_name": "text",
        "external_id": "text",
        "created_at": "2026-03-02T22:30:40.233Z",
        "updated_at": "2026-03-02T22:30:40.233Z",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    ]
  },
  "pagination": {
    "current_results": {
      "from": 1,
      "to": 1
    },
    "total_results": 1
  },
  "identifier": "text"
}

post

Create spaces.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Header parameters

x-configuration-idstringOptional

Optional configuration/scenario key. When omitted, the default configuration is used (configuration_id is null).

Body

application/json

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

post

/spaces

HTTPcURLJavaScriptPython

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

{
  "spaces": [
    {
      "location_id": "text",
      "location_name": "text",
      "layer_id": "text",
      "layer_name": "text",
      "position": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "settings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "external_id": "text"
    }
  ]
}

200

OK

{
  "success": true,
  "data": [
    {
      "_id": "text",
      "space_id": "text",
      "name": "text",
      "settings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "position": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "location_id": "text",
      "location_name": "text",
      "layer_id": "text",
      "layer_name": "text",
      "external_id": "text",
      "created_at": "2026-03-02T22:30:40.233Z",
      "updated_at": "2026-03-02T22:30:40.233Z",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "identifier": "text"
}

put

Update spaces.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Header parameters

x-configuration-idstringOptional

Optional configuration/scenario key. When omitted, the default configuration is used (configuration_id is null).

Body

application/json

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

put

/spaces

HTTPcURLJavaScriptPython

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

{
  "spaces": [
    {
      "space_id": "text",
      "name": "text",
      "settings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "position": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "external_id": "text"
    }
  ]
}

200

OK

{
  "success": true,
  "data": [
    {
      "_id": "text",
      "space_id": "text",
      "name": "text",
      "settings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "position": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "location_id": "text",
      "location_name": "text",
      "layer_id": "text",
      "layer_name": "text",
      "external_id": "text",
      "created_at": "2026-03-02T22:30:40.233Z",
      "updated_at": "2026-03-02T22:30:40.233Z",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "identifier": "text"
}

delete

Delete spaces.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Header parameters

x-configuration-idstringOptional

Optional configuration/scenario key. When omitted, the default configuration is used (configuration_id is null).

Body

application/json

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

delete

/spaces

HTTPcURLJavaScriptPython

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"
    }
  ]
}

200

OK

{
  "success": true,
  "data": [
    {
      "space_id": "text"
    }
  ],
  "identifier": "text"
}

get

Retrieve rooms with optional filters.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Query parameters

location_idstringOptional

layer_idstringOptional

room_idstringOptional

external_idstringOptional

geojsonbooleanOptionalDefault: false

imdfbooleanOptionalDefault: false

skipintegerOptionalDefault: 0

limitintegerOptionalDefault: 25

sortstringOptional

orderstring · enumOptionalDefault: ascPossible values:

Header parameters

x-configuration-idstringOptional

Optional configuration/scenario key. When omitted, the default configuration is used (configuration_id is null).

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

get

/rooms

HTTPcURLJavaScriptPython

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

200

OK

{
  "success": true,
  "data": {
    "rooms": [
      {
        "_id": "text",
        "room_id": "text",
        "name": "text",
        "type": "text",
        "location_id": "text",
        "location_name": "text",
        "layer_id": "text",
        "layer_name": "text",
        "settings": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "geometry": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "spaces": [],
        "amenities": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "external_id": "text",
        "created_at": "2026-03-02T22:30:40.233Z",
        "updated_at": "2026-03-02T22:30:40.233Z",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    ]
  },
  "pagination": {
    "current_results": {
      "from": 1,
      "to": 1
    },
    "total_results": 1
  },
  "identifier": "text"
}

post

Create rooms.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Header parameters

x-configuration-idstringOptional

Optional configuration/scenario key. When omitted, the default configuration is used (configuration_id is null).

Body

application/json

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

post

/rooms

HTTPcURLJavaScriptPython

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

{
  "rooms": [
    {
      "name": "text",
      "type": "text",
      "layer_id": "text",
      "layer_name": "text",
      "location_id": "text",
      "location_name": "text",
      "spaces": [],
      "settings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "amenities": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "geometry": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "external_id": "text"
    }
  ]
}

200

OK

{
  "success": true,
  "data": [
    {
      "_id": "text",
      "room_id": "text",
      "name": "text",
      "type": "text",
      "location_id": "text",
      "location_name": "text",
      "layer_id": "text",
      "layer_name": "text",
      "settings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "geometry": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "spaces": [],
      "amenities": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "external_id": "text",
      "created_at": "2026-03-02T22:30:40.233Z",
      "updated_at": "2026-03-02T22:30:40.233Z",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "identifier": "text"
}

put

Update rooms.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Header parameters

x-configuration-idstringOptional

Optional configuration/scenario key. When omitted, the default configuration is used (configuration_id is null).

Body

application/json

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

put

/rooms

HTTPcURLJavaScriptPython

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

{
  "rooms": [
    {
      "room_id": "text",
      "spaces": [],
      "amenities": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "settings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "type": "text",
      "name": "text",
      "geometry": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "external_id": "text"
    }
  ]
}

200

OK

{
  "success": true,
  "data": [
    {
      "_id": "text",
      "room_id": "text",
      "name": "text",
      "type": "text",
      "location_id": "text",
      "location_name": "text",
      "layer_id": "text",
      "layer_name": "text",
      "settings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "geometry": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "spaces": [],
      "amenities": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "external_id": "text",
      "created_at": "2026-03-02T22:30:40.233Z",
      "updated_at": "2026-03-02T22:30:40.233Z",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "identifier": "text"
}

delete

Delete rooms.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Header parameters

x-configuration-idstringOptional

Optional configuration/scenario key. When omitted, the default configuration is used (configuration_id is null).

Body

application/json

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

delete

/rooms

HTTPcURLJavaScriptPython

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"
    }
  ]
}

200

OK

{
  "success": true,
  "data": [
    {
      "room_id": "text"
    }
  ],
  "identifier": "text"
}

get

Retrieve zones with optional filters.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Query parameters

location_idstringOptional

layer_idstringOptional

zone_idstringOptional

external_idstringOptional

geojsonbooleanOptionalDefault: false

imdfbooleanOptionalDefault: false

skipintegerOptionalDefault: 0

limitintegerOptionalDefault: 25

sortstringOptional

orderstring · enumOptionalDefault: ascPossible values:

Header parameters

x-configuration-idstringOptional

Optional configuration/scenario key. When omitted, the default configuration is used (configuration_id is null).

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

get

/zones

HTTPcURLJavaScriptPython

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

200

OK

{
  "success": true,
  "data": {
    "zones": [
      {
        "_id": "text",
        "zone_id": "text",
        "name": "text",
        "spaces": [],
        "settings": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "location_id": "text",
        "location_name": "text",
        "layer_id": "text",
        "layer_name": "text",
        "external_id": "text",
        "created_at": "2026-03-02T22:30:40.233Z",
        "updated_at": "2026-03-02T22:30:40.233Z",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    ]
  },
  "pagination": {
    "current_results": {
      "from": 1,
      "to": 1
    },
    "total_results": 1
  },
  "identifier": "text"
}

post

Create zones.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Header parameters

x-configuration-idstringOptional

Optional configuration/scenario key. When omitted, the default configuration is used (configuration_id is null).

Body

application/json

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

post

/zones

HTTPcURLJavaScriptPython

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

{
  "zones": [
    {
      "name": "text",
      "spaces": [],
      "location_id": "text",
      "location_name": "text",
      "layer_id": "text",
      "layer_name": "text",
      "settings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "external_id": "text"
    }
  ]
}

200

OK

{
  "success": true,
  "data": [
    {
      "_id": "text",
      "zone_id": "text",
      "name": "text",
      "spaces": [],
      "settings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "location_id": "text",
      "location_name": "text",
      "layer_id": "text",
      "layer_name": "text",
      "external_id": "text",
      "created_at": "2026-03-02T22:30:40.233Z",
      "updated_at": "2026-03-02T22:30:40.233Z",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "identifier": "text"
}

put

Update zones.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Header parameters

x-configuration-idstringOptional

Optional configuration/scenario key. When omitted, the default configuration is used (configuration_id is null).

Body

application/json

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

put

/zones

HTTPcURLJavaScriptPython

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

{
  "zones": [
    {
      "zone_id": "text",
      "settings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "name": "text",
      "spaces": [],
      "external_id": "text"
    }
  ]
}

200

OK

{
  "success": true,
  "data": [
    {
      "_id": "text",
      "zone_id": "text",
      "name": "text",
      "spaces": [],
      "settings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "location_id": "text",
      "location_name": "text",
      "layer_id": "text",
      "layer_name": "text",
      "external_id": "text",
      "created_at": "2026-03-02T22:30:40.233Z",
      "updated_at": "2026-03-02T22:30:40.233Z",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "identifier": "text"
}

delete

Delete zones.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Header parameters

x-configuration-idstringOptional

Optional configuration/scenario key. When omitted, the default configuration is used (configuration_id is null).

Body

application/json

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

delete

/zones

HTTPcURLJavaScriptPython

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"
    }
  ]
}

200

OK

{
  "success": true,
  "data": [
    {
      "zone_id": "text"
    }
  ],
  "identifier": "text"
}

get

Retrieve clusters with optional filters.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Query parameters

location_idstringOptional

layer_idstringOptional

cluster_idstringOptional

external_idstringOptional

geojsonbooleanOptionalDefault: false

imdfbooleanOptionalDefault: false

skipintegerOptionalDefault: 0

limitintegerOptionalDefault: 25

sortstringOptional

orderstring · enumOptionalDefault: ascPossible values:

Header parameters

x-configuration-idstringOptional

Optional configuration/scenario key. When omitted, the default configuration is used (configuration_id is null).

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

get

/clusters

HTTPcURLJavaScriptPython

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

200

OK

{
  "success": true,
  "data": {
    "clusters": [
      {
        "_id": "text",
        "cluster_id": "text",
        "spaces": [],
        "location_id": "text",
        "location_name": "text",
        "layer_id": "text",
        "layer_name": "text",
        "external_id": "text",
        "created_at": "2026-03-02T22:30:40.233Z",
        "updated_at": "2026-03-02T22:30:40.233Z",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    ]
  },
  "pagination": {
    "current_results": {
      "from": 1,
      "to": 1
    },
    "total_results": 1
  },
  "identifier": "text"
}

post

Create clusters.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Header parameters

x-configuration-idstringOptional

Optional configuration/scenario key. When omitted, the default configuration is used (configuration_id is null).

Body

application/json

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

post

/clusters

HTTPcURLJavaScriptPython

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

{
  "clusters": [
    {
      "location_id": "text",
      "location_name": "text",
      "layer_id": "text",
      "layer_name": "text",
      "spaces": [],
      "settings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "external_id": "text"
    }
  ]
}

200

OK

{
  "success": true,
  "data": [
    {
      "_id": "text",
      "cluster_id": "text",
      "spaces": [],
      "location_id": "text",
      "location_name": "text",
      "layer_id": "text",
      "layer_name": "text",
      "external_id": "text",
      "created_at": "2026-03-02T22:30:40.233Z",
      "updated_at": "2026-03-02T22:30:40.233Z",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "identifier": "text"
}

put

Update clusters.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Header parameters

x-configuration-idstringOptional

Optional configuration/scenario key. When omitted, the default configuration is used (configuration_id is null).

Body

application/json

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

put

/clusters

HTTPcURLJavaScriptPython

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

{
  "clusters": [
    {
      "cluster_id": "text",
      "spaces": [],
      "settings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "external_id": "text"
    }
  ]
}

200

OK

{
  "success": true,
  "data": [
    {
      "_id": "text",
      "cluster_id": "text",
      "spaces": [],
      "location_id": "text",
      "location_name": "text",
      "layer_id": "text",
      "layer_name": "text",
      "external_id": "text",
      "created_at": "2026-03-02T22:30:40.233Z",
      "updated_at": "2026-03-02T22:30:40.233Z",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "identifier": "text"
}

delete

Delete clusters.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Header parameters

x-configuration-idstringOptional

Optional configuration/scenario key. When omitted, the default configuration is used (configuration_id is null).

Body

application/json

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

delete

/clusters

HTTPcURLJavaScriptPython

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"
    }
  ]
}

200

OK

{
  "success": true,
  "data": [
    {
      "cluster_id": "text"
    }
  ],
  "identifier": "text"
}

get

Retrieve areas with optional filters.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Query parameters

location_idstringOptional

layer_idstringOptional

area_idstringOptional

external_idstringOptional

geojsonbooleanOptionalDefault: false

imdfbooleanOptionalDefault: false

skipintegerOptionalDefault: 0

limitintegerOptionalDefault: 25

sortstringOptional

orderstring · enumOptionalDefault: ascPossible values:

Header parameters

x-configuration-idstringOptional

Optional configuration/scenario key. When omitted, the default configuration is used (configuration_id is null).

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

get

/areas

HTTPcURLJavaScriptPython

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

200

OK

{
  "success": true,
  "data": {
    "areas": [
      {
        "_id": "text",
        "area_id": "text",
        "geometry": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "location_id": "text",
        "location_name": "text",
        "layer_id": "text",
        "layer_name": "text",
        "external_id": "text",
        "created_at": "2026-03-02T22:30:40.233Z",
        "updated_at": "2026-03-02T22:30:40.233Z",
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    ]
  },
  "pagination": {
    "current_results": {
      "from": 1,
      "to": 1
    },
    "total_results": 1
  },
  "identifier": "text"
}

post

Create areas.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Header parameters

x-configuration-idstringOptional

Optional configuration/scenario key. When omitted, the default configuration is used (configuration_id is null).

Body

application/json

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

post

/areas

HTTPcURLJavaScriptPython

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

{
  "areas": [
    {
      "geometry": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "location_id": "text",
      "location_name": "text",
      "layer_id": "text",
      "layer_name": "text",
      "settings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "external_id": "text"
    }
  ]
}

200

OK

{
  "success": true,
  "data": [
    {
      "_id": "text",
      "area_id": "text",
      "geometry": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "location_id": "text",
      "location_name": "text",
      "layer_id": "text",
      "layer_name": "text",
      "external_id": "text",
      "created_at": "2026-03-02T22:30:40.233Z",
      "updated_at": "2026-03-02T22:30:40.233Z",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "identifier": "text"
}

put

Update areas.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Header parameters

x-configuration-idstringOptional

Optional configuration/scenario key. When omitted, the default configuration is used (configuration_id is null).

Body

application/json

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

put

/areas

HTTPcURLJavaScriptPython

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

{
  "areas": [
    {
      "area_id": "text",
      "geometry": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "settings": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "external_id": "text"
    }
  ]
}

200

OK

{
  "success": true,
  "data": [
    {
      "_id": "text",
      "area_id": "text",
      "geometry": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "location_id": "text",
      "location_name": "text",
      "layer_id": "text",
      "layer_name": "text",
      "external_id": "text",
      "created_at": "2026-03-02T22:30:40.233Z",
      "updated_at": "2026-03-02T22:30:40.233Z",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  ],
  "identifier": "text"
}

delete

Delete areas.

Authorizations

ApiKeyAuth

x-api-keystringRequired

Header parameters

x-configuration-idstringOptional

Optional configuration/scenario key. When omitted, the default configuration is used (configuration_id is null).

Body

application/json

Responses

200

OK

application/json

successbooleanRequired

identifierstringRequired

delete

/areas

HTTPcURLJavaScriptPython

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"
    }
  ]
}

200

OK

{
  "success": true,
  "data": [
    {
      "area_id": "text"
    }
  ],
  "identifier": "text"
}