---
title: "Fetch readers"
method: GET
path: "/readers"
tags: ["Readers"]
---

# Fetch readers

`GET /readers`

## Query parameters

- `ids` string
- `query` string
- `model` 'reader-1.0' | 'reader-2.0' | 'reader-pro-2.1' | 'reader-pro-2.1-hf' | 'reader-pro-3.0'
- `place_id` integer
- `lock_id` integer
- `limit` integer
- `offset` integer
- `status` 'online' | 'offline'
- `sort` 'name' | '-name'

## Response `200`

OK

- object[]
  - `id` integer, required — The ID of the reader
  - `resource_type` 'Reader', required — The resource type of the reader
  - `name` string, required — The name of the reader
  - `description` string, nullable, required — The description of the reader
  - `created_at` string, date-time, required — When the reader was created
  - `updated_at` string, date-time, required — When the reader was updated
  - `broadcast_ip_address` string, nullable, required — The broadcast IP address of the reader
  - `configured` boolean, required — Whether the reader is configured
  - `device_id` string, required — The device ID of the reader
  - `ethernet_mac` string, required — The ethernet MAC address of the reader
  - `gateway_ip_address` string, nullable, required — The gateway IP address of the reader
  - `ip_address` string, nullable, required — The IP address of the reader
  - `model` 'reader-1.0' | 'reader-2.0' | 'reader-pro-2.1' | 'reader-pro-2.1-hf' | 'reader-pro-3.0', required — The model of the reader
  - `network_interface` 'ethernet' | 'wifi' | 'null', nullable, required — The network interface of the reader
  - `network` string, nullable, required — The network of the reader
  - `online` boolean, required — Whether the reader is online
  - `revision` string, required — The revision of the reader
  - `token` string, required — The token of the reader
  - `wifi_mac` string, required — The wifi MAC address of the reader
  - `backplate` 'standard' | 'keypad_terminal' | 'quick_response_code_terminal' | 'keypad_and_quick_response_code_terminal', required — The backplate of the reader
  - `buzzer_enabled` boolean, required — Whether the reader is buzzer enabled
  - `cards_enabled` boolean, required — Whether the reader is cards enabled
  - `checkout` boolean, required — Whether the reader is checkout enabled
  - `device_unlock_restriction_enabled` boolean, required — Whether the reader is device unlock restriction enabled
  - `held_open_alarm_enabled` boolean, required — Whether the reader is held_open_alarm enabled"
  - `quick_response_code_enabled` boolean, required — Whether the reader is quick response code enabled
  - `tampered` boolean, required — Whether the reader is in a tampered state
  - `tamper_enabled` boolean, required — Whether the reader is tamper enabled
  - `wave_to_unlock_enabled` boolean, required — Whether the reader is wave to unlock enabled
  - `elevator_id` integer, nullable, required — The elevator ID of the reader
  - `elevator` object — The elevator of the reader
    - `id` integer, required — The ID of the elevator
    - `resource_type` 'Elevator', required — The resource type of the elevator
    - `name` string, required — The name of the elevator
  - `lock_id` integer, nullable, required — The lock ID of the reader
  - `lock` object — The lock of the reader
    - `id` integer, required — The ID of the lock
    - `resource_type` 'Lock', required — The resource type of the lock
    - `name` string, required — The name of the lock
  - `place_id` integer, required — The place ID of the reader
  - `place` object, required — The place of the reader
    - `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
  - `zone_id` integer, nullable, required — The zone ID of the reader
  - `zone` object — The zone of the reader
    - `id` integer, required — The ID of the zone
    - `name` string, required — The name of the zone
  - `terminal_id` integer, nullable, required — The terminal ID of the reader
  - `terminal` object — The terminal of the reader
    - `id` integer, required — The ID of the terminal
    - `resource_type` 'Terminal', required — The resource type of the terminal
    - `name` string, required — The name of the terminal

## 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)