Sign in

v1

latestOpenAPI 3.0.32026-07-2632131.4 MB
Complexes

Get a list of all complexes

Get a list of all complexes, including their IDs, titles, nicknames, propertyIds, and tags

get/properties-api/complexes

Response

A list of all complexes

idstring

The ID of the complex

titlestring

The title of the complex

nicknamestring

The nickname of the complex

propertyIdsstring[]

An array of IDs of the properties in the complex

tagsstring[]

An array of tags associated with the complex

Example response

[
  {
    "id": "645774fe76e5da340bf915e7",
    "title": "Complex 1",
    "nickname": "C1",
    "propertyIds": [
      "6457751476e5da340bf915e8",
      "6457751e76e5da340bf915e9"
    ],
    "tags": [
      "tag1",
      "tag2"
    ]
  },
  {
    "id": "6457752b76e5da340bf915ea",
    "title": "Complex 2",
    "nickname": "C2",
    "propertyIds": [],
    "tags": [
      "tag3",
      "tag4"
    ]
  }
]