Sign in
Readers

Fetch reader

get/readers/{id}

Path parameters

idinteger required

The ID of the object

Response

OK

idinteger required

The ID of the reader

resource_type'Reader' required

The resource type of the reader

namestring required

The name of the reader

descriptionstring nullable required

The description of the reader

created_atstring date-time required

When the reader was created

updated_atstring date-time required

When the reader was updated

broadcast_ip_addressstring nullable required

The broadcast IP address of the reader

configuredboolean required

Whether the reader is configured

device_idstring required

The device ID of the reader

ethernet_macstring required

The ethernet MAC address of the reader

gateway_ip_addressstring nullable required

The gateway IP address of the reader

ip_addressstring 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

networkstring nullable required

The network of the reader

onlineboolean required

Whether the reader is online

revisionstring required

The revision of the reader

tokenstring required

The token of the reader

wifi_macstring 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_enabledboolean required

Whether the reader is buzzer enabled

cards_enabledboolean required

Whether the reader is cards enabled

checkoutboolean required

Whether the reader is checkout enabled

device_unlock_restriction_enabledboolean required

Whether the reader is device unlock restriction enabled

held_open_alarm_enabledboolean required

Whether the reader is held_open_alarm enabled"

quick_response_code_enabledboolean required

Whether the reader is quick response code enabled

tamperedboolean required

Whether the reader is in a tampered state

tamper_enabledboolean required

Whether the reader is tamper enabled

wave_to_unlock_enabledboolean required

Whether the reader is wave to unlock enabled

elevator_idinteger nullable required

The elevator ID of the reader

lock_idinteger nullable required

The lock ID of the reader

place_idinteger required

The place ID of the reader

zone_idinteger nullable required

The zone ID of the reader

terminal_idinteger nullable required

The terminal ID of the reader

Changes

No recorded changes to this endpoint across all 1 revision of this API.