---
title: "Fetch groups"
method: GET
path: "/groups"
tags: ["Groups"]
---

# Fetch groups

`GET /groups`

## Query parameters

- `ids` string
- `query` string
- `limit` integer
- `offset` integer
- `scope` 'organization' | 'place'
- `place_id` string
- `elevator_stop_id` string
- `lock_id` string
- `sort` 'name' | '-name'

## Response `200`

OK

- object[]
  - `id` integer, required — The ID of the group
  - `resource_type` 'Group', required — The resource type of the group
  - `name` string, required — The name of the group
  - `description` string, nullable, required — The description of the group
  - `created_at` string, date-time, required — When the group was created
  - `updated_at` string, date-time, required — When the group was updated
  - `geofence_restriction_enabled` boolean, required — Whether geofence restriction is enabled
  - `geofence_restriction_radius` number, required
  - `primary_device_restriction_enabled` boolean, required — Whether primary device restriction is enabled
  - `managed_device_restriction_enabled` boolean, required — Whether managed device restriction is enabled
  - `reader_restriction_enabled` boolean, required — Whether reader proximity restriction is enabled
  - `time_restriction_enabled` boolean, required — Whether time restriction is enabled
  - `tap_to_access_restriction_enabled` boolean, required — Whether reader unlock restriction is enabled
  - `login_enabled` boolean, required — Whether app access is enabled
  - `users_count` integer, required — The number of users in the group
  - `locks_count` integer, required — The number of locks in the group
  - `elevator_stops_count` integer, required — The number of elevator stops in the group
  - `place_id` integer, nullable, required — The place ID of the group
  - `place` object — The place of the group
    - `id` integer, required — The ID of the place
    - `resource_type` 'Place', required — The resource type of the place
    - `name` string, required — The name of the place
  - `time_restriction_time_zone` string, nullable, required
  - `members_count` integer, required

## Other responses

- `401` — Unauthorized

---

[API](https://skmtc.dev/kisi/apis/kisi-api.md) · [All operations](https://skmtc.dev/kisi/apis/kisi-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/kisi/kisi-api/revisions/998700ffff5a/schema)