Skip to main content
GET

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
customer_key
string

Customer key for which you want to list events.

Minimum string length: 1
​
unstable_offset
number<float>

Offset for the events that you want to list.

​
since
string

Timestamp to indicate the beginning generation time for the events that you want to list. You must include since or between.

​
between
string[]

Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include since or between.

Required array length: 2 elements
​
device_id
string<uuid>

ID of the device for which you want to list events.

​
device_ids
string<uuid>[]

IDs of the devices for which you want to list events.

​
acs_system_id
string<uuid>

ID of the access system for which you want to list events.

​
acs_system_ids
string<uuid>[]

IDs of the access systems for which you want to list events.

​
access_code_id
string<uuid>

ID of the access code for which you want to list events.

​
access_code_ids
string<uuid>[]

IDs of the access codes for which you want to list events.

​
event_type
enum<string>

Type of the events that you want to list.

Available options:
access_code.created,
access_code.changed,
access_code.name_changed,
access_code.code_changed,
access_code.time_frame_changed,
access_code.mutations_requested,
access_code.scheduled_on_device,
access_code.set_on_device,
access_code.removed_from_device,
access_code.delay_in_setting_on_device,
access_code.failed_to_set_on_device,
access_code.issued,
access_code.delay_in_issuing,
access_code.failed_to_issue,
access_code.failed_to_update,
access_code.failed_to_expire,
access_code.deleted,
access_code.delay_in_removing_from_device,
access_code.failed_to_remove_from_device,
access_code.modified_external_to_seam,
access_code.deleted_external_to_seam,
access_code.backup_access_code_pulled,
access_code.unmanaged.converted_to_managed,
access_code.unmanaged.failed_to_convert_to_managed,
access_code.unmanaged.created,
access_code.unmanaged.removed,
access_grant.created,
access_grant.deleted,
access_grant.access_granted_to_all_doors,
access_grant.access_granted_to_door,
access_grant.access_to_door_lost,
access_grant.access_times_changed,
access_grant.could_not_create_requested_access_methods,
access_method.issued,
access_method.revoked,
access_method.card_encoding_required,
access_method.deleted,
access_method.reissued,
access_method.created,
access_method.delay_in_issuing,
access_method.failed_to_issue,
acs_system.connected,
acs_system.added,
acs_system.disconnected,
acs_credential.deleted,
acs_credential.issued,
acs_credential.reissued,
acs_credential.invalidated,
acs_user.created,
acs_user.deleted,
acs_encoder.added,
acs_encoder.removed,
acs_access_group.deleted,
acs_entrance.added,
acs_entrance.removed,
client_session.deleted,
connected_account.connected,
connected_account.created,
connected_account.successful_login,
connected_account.disconnected,
connected_account.completed_first_sync,
connected_account.deleted,
connected_account.completed_first_sync_after_reconnection,
connected_account.reauthorization_requested,
action_attempt.lock_door.succeeded,
action_attempt.lock_door.failed,
action_attempt.unlock_door.succeeded,
action_attempt.unlock_door.failed,
action_attempt.simulate_keypad_code_entry.succeeded,
action_attempt.simulate_keypad_code_entry.failed,
action_attempt.simulate_manual_lock_via_keypad.succeeded,
action_attempt.simulate_manual_lock_via_keypad.failed,
connect_webview.login_succeeded,
connect_webview.login_failed,
device.connected,
device.added,
device.converted_to_unmanaged,
device.unmanaged.converted_to_managed,
device.unmanaged.connected,
device.disconnected,
device.unmanaged.disconnected,
device.tampered,
device.low_battery,
device.battery_status_changed,
device.removed,
device.deleted,
device.third_party_integration_detected,
device.third_party_integration_no_longer_detected,
device.salto.privacy_mode_activated,
device.salto.privacy_mode_deactivated,
device.connection_became_flaky,
device.connection_stabilized,
device.error.subscription_required,
device.error.subscription_required.resolved,
device.accessory_keypad_connected,
device.accessory_keypad_disconnected,
noise_sensor.noise_threshold_triggered,
lock.locked,
lock.unlocked,
lock.access_denied,
thermostat.climate_preset_activated,
thermostat.manually_adjusted,
thermostat.temperature_threshold_exceeded,
thermostat.temperature_threshold_no_longer_exceeded,
thermostat.temperature_reached_set_point,
thermostat.temperature_changed,
device.name_changed,
camera.activated,
device.doorbell_rang,
enrollment_automation.deleted,
phone.deactivated,
space.device_membership_changed,
space.created,
space.deleted
​
event_types
enum<string>[]

Types of the events that you want to list.

Available options:
access_code.created,
access_code.changed,
access_code.name_changed,
access_code.code_changed,
access_code.time_frame_changed,
access_code.mutations_requested,
access_code.scheduled_on_device,
access_code.set_on_device,
access_code.removed_from_device,
access_code.delay_in_setting_on_device,
access_code.failed_to_set_on_device,
access_code.issued,
access_code.delay_in_issuing,
access_code.failed_to_issue,
access_code.failed_to_update,
access_code.failed_to_expire,
access_code.deleted,
access_code.delay_in_removing_from_device,
access_code.failed_to_remove_from_device,
access_code.modified_external_to_seam,
access_code.deleted_external_to_seam,
access_code.backup_access_code_pulled,
access_code.unmanaged.converted_to_managed,
access_code.unmanaged.failed_to_convert_to_managed,
access_code.unmanaged.created,
access_code.unmanaged.removed,
access_grant.created,
access_grant.deleted,
access_grant.access_granted_to_all_doors,
access_grant.access_granted_to_door,
access_grant.access_to_door_lost,
access_grant.access_times_changed,
access_grant.could_not_create_requested_access_methods,
access_method.issued,
access_method.revoked,
access_method.card_encoding_required,
access_method.deleted,
access_method.reissued,
access_method.created,
access_method.delay_in_issuing,
access_method.failed_to_issue,
acs_system.connected,
acs_system.added,
acs_system.disconnected,
acs_credential.deleted,
acs_credential.issued,
acs_credential.reissued,
acs_credential.invalidated,
acs_user.created,
acs_user.deleted,
acs_encoder.added,
acs_encoder.removed,
acs_access_group.deleted,
acs_entrance.added,
acs_entrance.removed,
client_session.deleted,
connected_account.connected,
connected_account.created,
connected_account.successful_login,
connected_account.disconnected,
connected_account.completed_first_sync,
connected_account.deleted,
connected_account.completed_first_sync_after_reconnection,
connected_account.reauthorization_requested,
action_attempt.lock_door.succeeded,
action_attempt.lock_door.failed,
action_attempt.unlock_door.succeeded,
action_attempt.unlock_door.failed,
action_attempt.simulate_keypad_code_entry.succeeded,
action_attempt.simulate_keypad_code_entry.failed,
action_attempt.simulate_manual_lock_via_keypad.succeeded,
action_attempt.simulate_manual_lock_via_keypad.failed,
connect_webview.login_succeeded,
connect_webview.login_failed,
device.connected,
device.added,
device.converted_to_unmanaged,
device.unmanaged.converted_to_managed,
device.unmanaged.connected,
device.disconnected,
device.unmanaged.disconnected,
device.tampered,
device.low_battery,
device.battery_status_changed,
device.removed,
device.deleted,
device.third_party_integration_detected,
device.third_party_integration_no_longer_detected,
device.salto.privacy_mode_activated,
device.salto.privacy_mode_deactivated,
device.connection_became_flaky,
device.connection_stabilized,
device.error.subscription_required,
device.error.subscription_required.resolved,
device.accessory_keypad_connected,
device.accessory_keypad_disconnected,
noise_sensor.noise_threshold_triggered,
lock.locked,
lock.unlocked,
lock.access_denied,
thermostat.climate_preset_activated,
thermostat.manually_adjusted,
thermostat.temperature_threshold_exceeded,
thermostat.temperature_threshold_no_longer_exceeded,
thermostat.temperature_reached_set_point,
thermostat.temperature_changed,
device.name_changed,
camera.activated,
device.doorbell_rang,
enrollment_automation.deleted,
phone.deactivated,
space.device_membership_changed,
space.created,
space.deleted
​
connected_account_id
string<uuid>

ID of the connected account for which you want to list events.

​
connect_webview_id
string<uuid>

ID of the Connect Webview for which you want to list events.

​
limit
number<float>
default:500

Numerical limit on the number of events to return.

​
event_ids
string<uuid>[]

IDs of the events that you want to list.

​
acs_entrance_id
string<uuid>

ID of the ACS entrance for which you want to list events.

​
acs_user_id
string<uuid>

ID of the ACS user for which you want to list events.

​
user_identity_id
string<uuid>

ID of the user identity for which you want to list events.

​
access_grant_id
string<uuid>

ID of the access grant for which you want to list events.

​
access_grant_ids
string<uuid>[]

IDs of the access grants for which you want to list events.

Maximum array length: 100
​
access_method_id
string<uuid>

ID of the access method for which you want to list events.

​
access_method_ids
string<uuid>[]

IDs of the access methods for which you want to list events.

Maximum array length: 100
​
acs_credential_id
string<uuid>

ID of the ACS credential for which you want to list events.

​
space_id
string<uuid>

ID of the space for which you want to list events.

​
space_ids
string<uuid>[]

IDs of the spaces for which you want to list events.

Maximum array length: 100
​
acs_access_group_id
string<uuid>

ID of the ACS access group for which you want to list events.

​
acs_encoder_id
string<uuid>

ID of the ACS encoder for which you want to list events.

Response

OK

​
events
object[]
required

Represents an event. Events let you know when something interesting happens in your workspace. For example, when a lock is unlocked, Seam creates a lock.unlocked event. When a device's battery level is low, Seam creates a device.battery_low event. See the event object.