---
title: "get list of spaces"
method: GET
path: "/spaces"
tags: ["spaces"]
---

# get list of spaces

`GET /spaces`

## Request

- Base URL: `https://api.relynk.io/v2.0.0`
- URL: `https://api.relynk.io/v2.0.0/spaces`
- Auth: one of:
  - HTTP bearer
  - API key in header `Authorization`

get list of spaces, these include rooms, floors/levels, buildings, etc.

## Query parameters

- `customerId` string, uuid, required
- `limit` integer
- `offset` integer
- `order` 'asc' | 'desc'
- `sort` 'id' | 'name'
- `name` string
- `name__contains` string
- `displayName` string
- `displayName__contains` string
- `id` string, uuid
- `type` string
- `subtype` string
- `levelNumber` integer
- `isPartOfSpaceId` string, uuid
- `path__contains` string
- `includeOptionalFields` string[]

## Response `200`

get list of spaces available

- Space[]
  - `customerId` string, uuid, required: customer id
  - `id` string, uuid, required: space id
  - `name` string, required: space name
  - `displayName` string, nullable: space display name
  - `path` string, required: space path
  - `subtype` string, required: space subtype
  - `type` string, required: space type
  - `levelNumber` integer, nullable: space level number
  - `isPartOfSpaceId` string, uuid, nullable: space is part of space id
  - `identifiers` object, required: space identifiers
  - `grossArea` number, nullable: space gross area
  - `netArea` number, nullable: space net area
  - `rentableArea` number, nullable: space rentable area
  - `hasPartSpaceIds` string[], nullable: space has part space ids
  - `isLocationOfAssetIds` string[], nullable: space is location of asset ids
  - `isLocationOfBuildingElementIds` string[], nullable: space is location of building element ids
  - `hasGeometryIds` string[], nullable
  - `maxOccupancy` integer, nullable: space max occupancy
  - `seatingCapacity` integer, nullable: space seating capacity
  - `hasFileIds` string[], nullable: space has file ids
  - `hasPointIds` string[], nullable: space has point ids
  - `isFedByAssetIds` string[], nullable: space is fed by asset ids
  - `isOwnedByAgentIds` string[], nullable: space is owned by agent ids
  - `includedByCollectionIds` string[], nullable: space included by collection ids
  - `meteredByAssetIds` string[], nullable: space metered by asset ids

---

[API](https://skmtc.dev/relynk/apis/relynk-api.md) - [All operations](https://skmtc.dev/relynk/apis/relynk-api/llms.txt) - [OpenAPI document](https://skmtc.dev/relynk/apis/relynk-api/revisions/735d9d0efe06?raw)