GEgetkisi
Groups

Fetch groups

get/groups

Request

  • Base URL
    https://api.kisi.io
  • Auth
    • API key in header Authorization
    • or OAuth 2
      Authorization codehttps://api.kisi.io/oauth/authorize
      Token URLhttps://api.kisi.io/oauth/token
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

idsstring

Filter by object IDs

querystring

Filter by a freetext string. Properties searched: name

limitinteger

The number of objects to return

offsetinteger

The number of objects to offset

scope'organization' | 'place'

Filter by scope

place_idstring

Filter by place ID

elevator_stop_idstring

Filter by elevator stop ID

lock_idstring

Filter by lock ID

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 group

resource_type'Group' required

The resource type of the group

namestring required

The name of the group

descriptionstring nullable required

The description of the group

created_atstring date-time required

When the group was created

updated_atstring date-time required

When the group was updated

geofence_restriction_enabledboolean required

Whether geofence restriction is enabled

geofence_restriction_radiusnumber required
primary_device_restriction_enabledboolean required

Whether primary device restriction is enabled

managed_device_restriction_enabledboolean required

Whether managed device restriction is enabled

reader_restriction_enabledboolean required

Whether reader proximity restriction is enabled

time_restriction_enabledboolean required

Whether time restriction is enabled

tap_to_access_restriction_enabledboolean required

Whether reader unlock restriction is enabled

login_enabledboolean required

Whether app access is enabled

users_countinteger required

The number of users in the group

locks_countinteger required

The number of locks in the group

elevator_stops_countinteger required

The number of elevator stops in the group

place_idinteger nullable required

The place ID of the group

time_restriction_time_zonestring nullable required
members_countinteger required

Changes

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