Skip to main content
GET
List connectors
The list holds every connector in the building, not only those you created through the API. Connectors created with Create a KODE API connector have integrationType set to API_KODE. Only those connectors accept ingested devices and points. The default order is the connector _id, newest first. Use asc or dsc with name to sort by name.

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.

Path Parameters

buildingId
string
required

Building identifier from List buildings.

Query Parameters

asc
string

The field to sort by, ascending. For example, name.

dsc
string
default:_id

The field to sort by, descending. The default is _id.

limit
integer<int32>
default:50

Number of connectors per page, from 1 to 200.

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

Text to look for in the connector name. The match ignores case and finds the text anywhere in the name.

Response

A page of connectors.

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