GraphQL API

Endpoint

https://api.archilogic.com/graphql

This API is available to customers using Space Graph.

In parallel to the REST API we offer a GraphQL API that allows you to run complex queries against your entire portfolio or individual floors or layouts.

The GraphQL API leverages our graph-based spatial data format, that describes a layout as a planar graph.

The main queries are getFloors, getFloorById and getLayoutById

Authentication

You can use the GraphQL endpoint with the same authentication and token scopes like the REST API. Authentication and Authorization

Get buildings

Querying against your entire portfolio. Use filters for complex queries.

query {
  getBuildings {
    id
    name
    createdAt
    updatedAt
    floors {
      id
      name
      area
      spaces {
        id
      }
    }
  }
}

Get building by id

Query resources inside a specific building.

query ($buildingId: ID!) {
  getBuildingById(id: $buildingId) {
    id
    name
    createdAt
    updatedAt
    floors {
      id
      name
    }
  }
}

Get floors

Querying against your entire portfolio. Use filters for complex queries. Optionally you can use pagination

query {
  getFloors {
    floors {
      id
      name
      area
    }
  }
}

By default only non-archived floors are returned. Pass archived: true to include only archived floors, or query both with two separate requests. See Archived floors for details on which fields are available for archived floors.

query {
  getFloors(archived: true) {
    floors {
      id
      name
      isArchived
    }
  }
}

For a detailed overview take a look at the resources

Get floor by id

Query resources inside a specific floor.

query ($floorId: ID!) {
  getFloorById(id: $floorId) {
    id
    name
    isArchived
    spaces {
      id
      area
    }
  }
}

Get layout by id

Query resources inside a specific layout.

query ($layoutId: ID!) {
  getLayoutById(id: $layoutId) {
    id
    name
    isArchived
    spaces {
      id
      area
    }
  }
}