Spatial API

The Spatial API is designed to manage hierarchical spatial data within a division. It includes entities such as layers, spaces, rooms, clusters, areas, and layer circulation. The API provides endpoints to create, retrieve, update, and delete these location-related entities, allowing for comprehensive management and organisation of spatial information.

PreviousTeams API NextWorkplace API

Last updated 2 months ago

Was this helpful?

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

GEThttps://api.gospace.app/spatial/v1/locations

Authorization

Query parameters

Response

Body

successboolean

dataobject

identifierstring

Request

const response = await fetch('https://api.gospace.app/spatial/v1/locations', {
    method: 'GET',
    headers: {
      "x-api-key": "ApiKeyAuth <apiKey>"
    },
});
const data = await response.json();

Response

{
  "success": true,
  "data": {
    "locations": [
      {},
      {}
    ],
    "pagination": {
      "current_results": {
        "from": 1,
        "to": 25
      },
      "total_results": 100
    }
  },
  "identifier": "get_locations_successful"
}

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

GEThttps://api.gospace.app/spatial/v1/layers

Authorization

Query parameters

Response

Body

successboolean

dataobject

identifierstring

Request

const response = await fetch('https://api.gospace.app/spatial/v1/layers', {
    method: 'GET',
    headers: {
      "x-api-key": "ApiKeyAuth <apiKey>"
    },
});
const data = await response.json();

Response

{
  "success": true,
  "data": {
    "layers": [
      {},
      {}
    ],
    "pagination": {
      "current_results": {
        "from": 1,
        "to": 25
      },
      "total_results": 100
    }
  },
  "identifier": "get_layers_successful"
}

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

GEThttps://api.gospace.app/spatial/v1/spaces

Authorization

Query parameters

Response

Body

successboolean

dataobject

identifierstring

Request

const response = await fetch('https://api.gospace.app/spatial/v1/spaces', {
    method: 'GET',
    headers: {
      "x-api-key": "ApiKeyAuth <apiKey>"
    },
});
const data = await response.json();

Response

{
  "success": true,
  "data": {
    "spaces": [
      {},
      {}
    ],
    "pagination": {
      "current_results": {
        "from": 1,
        "to": 25
      },
      "total_results": 100
    }
  },
  "identifier": "get_spaces_successful"
}

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

GEThttps://api.gospace.app/spatial/v1/rooms

Authorization

Query parameters

Response

Body

successboolean

dataobject

identifierstring

Request

const response = await fetch('https://api.gospace.app/spatial/v1/rooms', {
    method: 'GET',
    headers: {
      "x-api-key": "ApiKeyAuth <apiKey>"
    },
});
const data = await response.json();

Response

{
  "success": true,
  "data": {
    "rooms": [
      {},
      {}
    ],
    "pagination": {
      "current_results": {
        "from": 1,
        "to": 25
      },
      "total_results": 100
    }
  },
  "identifier": "get_rooms_successful"
}

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

GEThttps://api.gospace.app/spatial/v1/areas

Authorization

Query parameters

Response

Body

successboolean

dataobject

identifierstring

Request

const response = await fetch('https://api.gospace.app/spatial/v1/areas', {
    method: 'GET',
    headers: {
      "x-api-key": "ApiKeyAuth <apiKey>"
    },
});
const data = await response.json();

Response

{
  "success": true,
  "data": {
    "areas": [
      {},
      {}
    ],
    "pagination": {
      "current_results": {
        "from": 1,
        "to": 25
      },
      "total_results": 100
    }
  },
  "identifier": "get_areas_successful"
}

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

GEThttps://api.gospace.app/spatial/v1/zones

Authorization

Query parameters

Response

Body

successboolean

dataobject

identifierstring

Request

const response = await fetch('https://api.gospace.app/spatial/v1/zones', {
    method: 'GET',
    headers: {
      "x-api-key": "ApiKeyAuth <apiKey>"
    },
});
const data = await response.json();

Response

{
  "success": true,
  "data": {
    "zones": [
      {},
      {}
    ],
    "pagination": {
      "current_results": {
        "from": 1,
        "to": 25
      },
      "total_results": 100
    }
  },
  "identifier": "get_zones_successful"
}

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

GEThttps://api.gospace.app/spatial/v1/clusters

Authorization

Query parameters

Response

Body

successboolean

dataobject

identifierstring

Request

const response = await fetch('https://api.gospace.app/spatial/v1/clusters', {
    method: 'GET',
    headers: {
      "x-api-key": "ApiKeyAuth <apiKey>"
    },
});
const data = await response.json();

Response

{
  "success": true,
  "data": {
    "clusters": [
      {},
      {}
    ],
    "pagination": {
      "current_results": {
        "from": 1,
        "to": 25
      },
      "total_results": 100
    }
  },
  "identifier": "get_clusters_successful"
}

Retrieve circulation within a location and layer, optionally filtered by circulation ID.

GEThttps://api.gospace.app/spatial/v1/circulation

Authorization

Query parameters

Response

Body

successboolean

dataobject

identifierstring

Request

const response = await fetch('https://api.gospace.app/spatial/v1/circulation', {
    method: 'GET',
    headers: {
      "x-api-key": "ApiKeyAuth <apiKey>"
    },
});
const data = await response.json();

Response

{
  "success": true,
  "data": {
    "circulation": [
      {},
      {}
    ],
    "pagination": {
      "current_results": {
        "from": 1,
        "to": 25
      },
      "total_results": 100
    }
  },
  "identifier": "get_circulation_successful"
}