RelynkLearn
Builder APIAPI referenceBuildings

buildings.list (version 1)

Buildings the user can see in this tenant, ordered by name, or by how well they match search. Page with offset while hasMore is true.

POST
/buildings.list/v1

Authorization

bearer
headerAuthorizationBearer <JWT>

A signed-in Relynk user's access token: OAuth 2.0 authorization code with PKCE at https://auth.relynk.io/authorize and https://auth.relynk.io/oauth/token, with audience https://ai.relynk.io/builder. The caller sees exactly what that user may see.

Query Parameters

tenantId?string

The tenant to read. May be left out when the caller belongs to exactly one tenant; GET /me lists them.

Formatuuid

Request Body

application/json
  1. body
search?string

Only buildings whose name resembles this text (fuzzy: a word, part of a name or a near miss), best matches first

Length1 <= length <= 200
limit?integer

Buildings per page

Range1 <= value <= 500
Default100
offset?integer

Buildings to skip, for paging

Range0 <= value <= 9007199254740991
Default0

Response Body

The function output

application/json
  1. response
buildings*array<>
Itemsitems <= 500
hasMore*boolean

True when more buildings follow this page

Example Request
curl -X POST 'https://ai.relynk.io/builder/v1/buildings.list/v1' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "buildings": [    {      "id": "string",      "name": "string"    }  ],  "hasMore": true}

Who the token acts as and the tenants it can read GET

Who the token acts as and the tenants it can read

resourceTypes.list (version 1) POST

The REC/Brick types the tenant actually uses, with how many resources of each type, e.g. to find the type keys of rooms, air handling units or temperature sensors before filtering other functions by them.