Skip to main content
GET
List connection keys
A connection key names a relationship between devices, such as a device that supplies air to another. The list is the same for the whole organization. To see which keys a given canonical type accepts, and in which direction, call List connections for a canonical type. The order is fixed, so asc and dsc have no effect.

Authorizations

Authorization
string
header
required

Paste an access token from Create an access token. Tokens expire, so request a new one if you receive 401.

Query Parameters

asc
string

Not used. The order is fixed.

dsc
string
default:_id

Not used. The order is fixed.

limit
integer<int32>
default:50

Maximum number of keys to return, from 1 to 200. The default is 50.

Required range: 1 <= x <= 200
page
integer<int32>
default:1

Page number to return. The first page is 1.

Required range: x >= 1
q
string

Return only keys that contain this text. The match is case-insensitive.

Response

A page of connection keys, as a list of strings.

data
string[]
page
integer<int32>
limit
integer<int32>
pageCount
integer<int32>
itemCount
integer<int32>