Controllers

Fetch controllers

get/controllers

Request

  • Base URL
    https://api.kisi.io
  • URL
    https://api.kisi.io/controllers
  • Auth
    • API key in header Authorization
    • or OAuth 2
      Authorization code: https://api.kisi.io/oauth/authorize
      Token URL: https://api.kisi.io/oauth/token

Query parameters

idsstring

Filter by object IDs

querystring

Filter by a freetext string. Properties searched: name, device_id, token

place_idinteger

Filter by place ID

lock_idinteger

Filter by lock ID

limitinteger

The number of objects to return

offsetinteger

The number of objects to offset

status'online' | 'offline'

Filter by status

sort'name' | '-name'

Sort the results. Prepend - to sort in reverse order.

name - sort by group name, alphabetically

Response

OK

idinteger required

The ID of the controller

resource_type'Controller' required

The resource type of the controller

namestring required

The name of the controller

descriptionstring nullable required

The description of the controller

created_atstring date-time required

When the controller was created

updated_atstring date-time required

When the controller was updated

broadcast_ip_addressstring nullable required

The broadcast IP address of the controller

configuredboolean required

Whether the controller is configured

device_idstring required

The device ID of the controller

ethernet_macstring required

The ethernet MAC address of the controller

gateway_ip_addressstring nullable required

The gateway IP address of the controller

ip_addressstring nullable required

The IP address of the controller

model'router-8.0' | 'controller-pro-1.1' | 'controller-pro-2.0' required

The model of the controller

network_interface'ethernet' | 'wifi' | 'null' nullable required

The network interface of the controller

networkstring nullable required

The network of the controller

onlineboolean required

Whether the controller is online

revisionstring required

The revision of the controller

tokenstring required

The token of the controller

wifi_macstring required

The wifi MAC address of the controller

zone_controllerboolean required

Whether the controller is a zone_controller

place_idinteger required

The place ID of the controller

Changes

No recorded changes to this operation across all 9 revisions of this API.