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

# get list of collections

`GET /collections`

## Request

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

get list of collections, these can include collections of assets, spaces, building elements, etc.

## Query parameters

- `customerId` string, uuid, required
- `limit` integer
- `offset` integer
- `order` 'asc' | 'desc'
- `sort` 'id' | 'name'
- `name` string
- `name__contains` string
- `id` string, uuid
- `subtype` string
- `includeOptionalFields` string[]

## Response `200`

get list of collections available

- Collection[]
  - `customerId` string, uuid, required: customer id
  - `id` string, uuid, required: collection id
  - `name` string, required: collection name
  - `identifiers` object, required: collection identifiers
  - `subtype` string, required: collection subtype
  - `totalGrossArea` number, nullable: collection total gross area
  - `totalNetArea` number, nullable: collection total net area
  - `totalRentableArea` number, nullable: collection total rentable area
  - `includesAssetIds` string[], nullable: collection includes asset ids
  - `includesSpaceIds` string[], nullable: collection includes space ids
  - `includesBuildingElementIds` string[], nullable: collection includes building element ids
  - `isOwnedByAgentIds` string[], nullable: collection is owned by agent ids
  - `isMeteredByAssetIds` string[], nullable: collection is 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)