v1

latestOpenAPI 3.0.32026-07-26134195287.9 KB
Events

Get Access Events

Returns events for an organization within a specified time range.

get/events/v1/access

Query parameters

start_timeinteger

The start of the time range for requested events. Formatted as a Unix timestamp in seconds. Default value is an hour ago from the current time.

end_timeinteger

The end of the time range for requested events. Formatted as a Unix timestamp in seconds. Default value is the current time.

page_tokenstring

The pagination token used to fetch the next page of results.

page_sizeinteger

The number of items returned in a single response. Default is 100. Max is 200.

event_typestring

One or multiple comma separated values from <code>door_opened</code>, <code>door_rejected</code>, <code>door_granted</code>, <code>door_forced_open</code>, <code>door_held_open</code>, <code>door_tailgating</code>, <code>door_crowd_detection</code>, <code>door_tamper</code>, <code>door_poi_detection</code>, <code>door_initialized</code>, <code>door_armed</code>, <code>door_armed_button_pressed</code>, <code>door_aux_unlock</code>, <code>door_locked</code>, <code>door_unlocked</code>, <code>door_unarmed_event</code>, <code>door_code_entered_event</code>, <code>door_button_press_entered_event</code>, <code>door_lock_state_changed</code>, <code>door_lockdown</code>, <code>door_auxinput_change_state</code>, <code>door_auxinput_held</code>, <code>door_low_battery</code>, <code>door_critical_battery</code>, <code>door_mobile_nfc_scan_accepted</code>, <code>door_mobile_nfc_scan_rejected</code>, <code>door_user_database_corrupt</code>, <code>door_keycard_entered_accepted</code>, <code>door_keycard_entered_rejected</code>, <code>door_code_entered_accepted</code>, <code>door_code_entered_rejected</code>, <code>door_remote_unlock_accepted</code>, <code>door_remote_unlock_rejected</code>, <code>door_press_to_exit_accepted</code>, <code>door_ble_unlock_attempt_accepted</code>, <code>door_ble_unlock_attempt_rejected</code>, <code>door_acu_offline</code>, <code>door_fire_alarm_triggered</code>, <code>door_fire_alarm_released</code>, <code>door_acu_fire_alarm_triggered</code>, <code>door_acu_fire_alarm_released</code>, <code>door_schedule_toggle</code>, <code>door_acu_dpi_cut</code>, <code>door_acu_dpi_short</code>, <code>door_acu_rex_cut</code>, <code>door_acu_rex_short</code>, <code>door_acu_rex2_cut</code>, <code>door_acu_rex2_short</code>, <code>door_acu_auxinput_cut</code>, <code>door_acu_auxinput_short</code>, <code>door_lockdown_debounced</code>, <code>door_lp_presented_accepted</code>, <code>door_lp_presented_rejected</code>, <code>door_apb_double_entry</code>, <code>door_apb_double_exit</code>, <code>all_access_granted</code>, <code>all_access_rejected</code>, <code>door_auxoutput_activated</code>.<code>door_auxoutput_deactivated</code>.<code>door_schedule_override_applied</code>, <code>door_schedule_override_removed</code>.

site_idstring

One or multiple comma separated values of site identifiers.

device_idstring

One or multiple comma separated values of device identifiers.

user_idstring

One or multiple comma separated values of user identifiers.

Response

OK

next_page_tokenstring

The pagination token used to fetch the next page of results.