RErelynk
spaces

get list of spaces

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

get/spaces

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

displayNamestring

filter by display name

displayName__containsstring

filter by display name contains

idstring uuid

filter by id

typestring

filter by category using brickschema/real estate core standard full uri.

subtypestring

filter by subtype using brickschema/real estate core standard full uri.

levelNumberinteger

filter by level number

isPartOfSpaceIdstring uuid

filter by is part of space id

path__containsstring

filter by path contains space ids . seperated

includeOptionalFieldsstring[]

include optional fields

Response

get list of spaces available

customerIdstring uuid required

customer id

idstring uuid required

space id

namestring required

space name

displayNamestring nullable

space display name

pathstring required

space path

subtypestring required

space subtype

typestring required

space type

levelNumberinteger nullable

space level number

isPartOfSpaceIdstring uuid nullable

space is part of space id

identifiersobject required

space identifiers

grossAreanumber nullable

space gross area

netAreanumber nullable

space net area

rentableAreanumber nullable

space rentable area

hasPartSpaceIdsstring[] nullable

space has part space ids

isLocationOfAssetIdsstring[] nullable

space is location of asset ids

isLocationOfBuildingElementIdsstring[] nullable

space is location of building element ids

hasGeometryIdsstring[] nullable
maxOccupancyinteger nullable

space max occupancy

seatingCapacityinteger nullable

space seating capacity

hasFileIdsstring[] nullable

space has file ids

hasPointIdsstring[] nullable

space has point ids

isFedByAssetIdsstring[] nullable

space is fed by asset ids

isOwnedByAgentIdsstring[] nullable

space is owned by agent ids

includedByCollectionIdsstring[] nullable

space included by collection ids

meteredByAssetIdsstring[] nullable

space metered by asset ids

Example response

[
  {
    "customerId": "123e4567-e89b-12d3-a456-426614174000",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Meeting Room 1",
    "path": "a646a595-ead8-5380-a2d0-199564e8dba0.123e4567-e89b-12d3-a456-426614174000",
    "subtype": "https://w3id.org/rec#MeetingRoom",
    "type": "https://w3id.org/rec#Room",
    "isPartOfSpaceId": "a646a595-ead8-5380-a2d0-199564e8dba0",
    "identifiers": {}
  }
]

Changes

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