List Events
List event emitted within a users workspace
List Events
GET
https://connect.getseam.com/events/list
Headers
Name | Type | Description |
---|---|---|
Authorization* | String | Bearer <API_KEY> |
Request Body
Name | Type | Description |
---|---|---|
since* | String | Date since when events were generated |
device_id | String | ID of the Device |
device_ids | String | IDs of the Devices |
access_code_id | String | ID of the Access Code |
access_code_ids | String | IDs of the Access Codes |
event_type | Get all events by type: \ "device.connected" | "device.disconnected" | "device.tampered" | "device.low_battery" | "access_code.created" | "noise_detection.detected_noise" | "connected_account.disconnected" | |
event_types | String | Get all events by types: \ "device.connected" | "device.disconnected" | "device.tampered" | "device.low_battery" | "access_code.created" | "noise_detection.detected_noise" | "connected_account.disconnected" |
Code Example
To programmatically access events, you can use events.list
. This will return the same events that would be sent to a webhook, however events.list
allows you to filter or see events that already took place.
Parameters
| type: string Optional | Datetime since when events were generated |
| type: [string, string] Optional | Lower and upper datetimes to filter by (exclusive interval) |
| type: string Optional | ID of the Device |
| type: string[] Optional | IDs of the Devices to include |
| type: string Optional | ID of the Access Code |
| type: string[] Optional | IDs of the Access Codes to include |
| type: string Optional | Get all events by type. See the Events page for a full list of Event types. |
| type: string[] Optional | Get all events by types. See the Events page for a full list of Event types. |
Exactly one of since
, between
must be provided.
Response
This section shows the JSON response returned by the API. Since each language encapsulates this response inside objects specific to that language and/or implementation, the actual type in your language might differ from what’s written here.
JSON format
Last updated