collections

get list of collections

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

get/collections

Request

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

Query parameters

customerIdstring uuid required

customer id context, id can be fetched from /customers endpoint

limitinteger

limit the number returned

offsetinteger

offset the returned list

order'asc' | 'desc'

order the returned list

sort'id' | 'name'

sort the returned list

namestring

filter by name

name__containsstring

filter by name contains

idstring uuid

filter by id

subtypestring

filter by subtype

includeOptionalFieldsstring[]

include optional fields

Response

get list of collections available

customerIdstring uuid required

customer id

idstring uuid required

collection id

namestring required

collection name

identifiersobject required

collection identifiers

subtypestring required

collection subtype

totalGrossAreanumber nullable

collection total gross area

totalNetAreanumber nullable

collection total net area

totalRentableAreanumber nullable

collection total rentable area

includesAssetIdsstring[] nullable

collection includes asset ids

includesSpaceIdsstring[] nullable

collection includes space ids

includesBuildingElementIdsstring[] nullable

collection includes building element ids

isOwnedByAgentIdsstring[] nullable

collection is owned by agent ids

isMeteredByAssetIdsstring[] nullable

collection is metered by asset ids

Example response

[
  {
    "customerId": "123e4567-e89b-12d3-a456-426614174000",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Building 1 Assets",
    "subtype": "AssetCollection",
    "identifiers": {},
    "totalGrossArea": 1000.5,
    "totalNetArea": 800.3,
    "totalRentableArea": 900.1
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.