List Events

List events emitted within your workspace

/events/list

post

Returns a list of all events. This endpoint returns the same events that would be sent to a webhook, but it enables you to filter or see events that already took place.

Authorizations

Body

unstable_offsetnumber · floatOptional

Offset for the events that you want to list.

sincestringOptional

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

device_idstring · uuidOptional

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

device_idsstring · uuid[]Optional

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

acs_system_idstring · uuidOptional

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

acs_system_idsstring · uuid[]Optional

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

access_code_idstring · uuidOptional

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

access_code_idsstring · uuid[]Optional

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

event_typestring · enumOptional

Type of the events that you want to list.

Possible values:

connected_account_idstring · uuidOptional

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

connect_webview_idstring · uuidOptional

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

limitnumber · floatOptional

Numerical limit on the number of events to return.

Default: 500

event_idsstring · uuid[]Optional

IDs of the events that you want to list.

customer_idsstring · uuid[]Optional

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

Responses

200

application/json

400

Bad Request

401

Unauthorized

post

POST /events/list HTTP/1.1
Host: connect.getseam.com
Authorization: Bearer Client Session Token
Content-Type: application/json
Accept: */*
Content-Length: 704

{
  "unstable_offset": 1,
  "since": "text",
  "between": [
    "text"
  ],
  "device_id": "123e4567-e89b-12d3-a456-426614174000",
  "device_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
  "acs_system_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "access_code_id": "123e4567-e89b-12d3-a456-426614174000",
  "access_code_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "event_type": "access_code.created",
  "event_types": [
    "access_code.created"
  ],
  "connected_account_id": "123e4567-e89b-12d3-a456-426614174000",
  "connect_webview_id": "123e4567-e89b-12d3-a456-426614174000",
  "limit": 500,
  "event_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "customer_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

{
  "events": [
    {
      "event_id": "123e4567-e89b-12d3-a456-426614174000",
      "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2025-06-26T06:40:59.749Z",
      "occurred_at": "2025-06-26T06:40:59.749Z",
      "access_code_id": "123e4567-e89b-12d3-a456-426614174000",
      "device_id": "123e4567-e89b-12d3-a456-426614174000",
      "connected_account_id": "123e4567-e89b-12d3-a456-426614174000",
      "event_type": "access_code.created"
    }
  ],
  "ok": true
}

Request

To access events programmatically, use events.list. This endpoint returns the same events that would be sent to a webhook, but events.list enables you to filter or see events that already took place.

Request Body Parameters

Parameter

Type

Description

since

String Optional

Timestamp since when events were generated. You must include since or between.

between

[String, String] Optional

Lower and upper timestamps by which to filter (exclusive interval). You must include since or between.

device_id

String Optional

ID of the devices to include.

device_ids

String[] Optional

IDs of the devices to include.

access_code_id

String Optional

ID of the access code to include.

access_code_ids

String[] Optional

IDs of the access codes to include.

connected_account_id

String Optional

ID of the connected account to include.

connect_webview_id

String Optional

ID of the Connect Webview to include.

event_type

String Optional

Type of events to include.

event_types

String[] Optional

Types of events to include.

limit

Number Optional

Limit of events to return. Default: 500.

Sample Request

await seam.events.list()

/*
[
  {
    event_id: '87b2dcda-90ff-4602-8ccc-efb2f4a3d7c2',
    event_type: 'device.low_battery',
    created_at: '2022-08-24T11:23:49.459Z',
    device_id: 'a83690b2-2b70-409a-9a94-426699b84c97',
    workspace_id: 'f97073eb-c003-467a-965b-e6dba3a0131d',
    battery_level: 0.48
  },
  {
    event_id: '2fc8d1bc-7b4d-4960-9aa4-7e6bf5dc5848',
    event_type: 'device.low_battery',
    created_at: '2022-08-24T11:23:49.335Z',
    device_id: 'a3f30bd2-f6d7-4bad-ba89-1bad3bf1bce4',
    workspace_id: 'f97073eb-c003-467a-965b-e6dba3a0131d',
    battery_level: 0.48
  }
]
*/

seam.events.list()

# [
#     Event(
#         event_id="87b2dcda-90ff-4602-8ccc-efb2f4a3d7c2",
#         event_type="device.low_battery",
#         created_at="2022-08-24T11:23:49.459Z",
#         device_id="a83690b2-2b70-409a-9a94-426699b84c97",
#         workspace_id="f97073eb-c003-467a-965b-e6dba3a0131d",
#         battery_level=0.48,
#     )
# ]

seam.events.list

# [<Seam::Event:0x007cd58
#   event_id="87b2dcda-90ff-4602-8ccc-efb2f4a3d7c2",
#   event_type="device.low_battery",
#   created_at="2022-08-24T11:23:49.459Z",
#   device_id="a83690b2-2b70-409a-9a94-426699b84c97",
#   workspace_id="f97073eb-c003-467a-965b-e6dba3a0131d",
#   battery_level=>0.48>]

$events = $seam->events->list();

echo json_encode($events)
/*
[
  {
    event_id: '87b2dcda-90ff-4602-8ccc-efb2f4a3d7c2',
    event_type: 'device.low_battery',
    created_at: '2022-08-24T11:23:49.459Z',
    device_id: 'a83690b2-2b70-409a-9a94-426699b84c97',
    workspace_id: 'f97073eb-c003-467a-965b-e6dba3a0131d',
    battery_level: 0.48
  },
  {
    event_id: '2fc8d1bc-7b4d-4960-9aa4-7e6bf5dc5848',
    event_type: 'device.low_battery',
    created_at: '2022-08-24T11:23:49.335Z',
    device_id: 'a3f30bd2-f6d7-4bad-ba89-1bad3bf1bce4',
    workspace_id: 'f97073eb-c003-467a-965b-e6dba3a0131d',
    battery_level: 0.48
  }
]
*/

Response

Returns an events array.

Sample Response

{
  "events": [
    {
      "event_id": "87b2dcda-90ff-4602-8ccc-efb2f4a3d7c2",
      "event_type": "device.low_battery",
      "created_at": "2022-08-24T11:23:49.459Z",
      "device_id": "a83690b2-2b70-409a-9a94-426699b84c97",
      "workspace_id": "f97073eb-c003-467a-965b-e6dba3a0131d",
      "battery_level": 0.48
    },
    {
      "event_id": "2fc8d1bc-7b4d-4960-9aa4-7e6bf5dc5848",
      "event_type": "device.low_battery",
      "created_at": "2022-08-24T11:23:49.335Z",
      "device_id": "a3f30bd2-f6d7-4bad-ba89-1bad3bf1bce4",
      "workspace_id": "f97073eb-c003-467a-965b-e6dba3a0131d",
      "battery_level": 0.48
    },
    {
      "event_id": "c99b497b-5ff6-4658-854a-4ee694d35355",
      "event_type": "device.low_battery",
      "created_at": "2022-08-24T11:23:49.150Z",
      "device_id": "65803a1c-866b-45ed-94d5-496b40e4cc4d",
      "workspace_id": "f97073eb-c003-467a-965b-e6dba3a0131d",
      "battery_level": 0.48
    },
    {
      "event_id": "e52e2527-c905-43e5-b84a-87122b64cdda",
      "event_type": "device.connected",
      "created_at": "2022-08-24T11:14:37.119Z",
      "device_id": "a83690b2-2b70-409a-9a94-426699b84c97",
      "workspace_id": "f97073eb-c003-467a-965b-e6dba3a0131d"
    },
    {
      "event_id": "5d9dce4c-9119-4888-acd6-42044c9740b0",
      "event_type": "device.connected",
      "created_at": "2022-08-24T11:14:36.981Z",
      "device_id": "a3f30bd2-f6d7-4bad-ba89-1bad3bf1bce4",
      "workspace_id": "f97073eb-c003-467a-965b-e6dba3a0131d"
    },
    {
      "event_id": "fea998c1-e2c7-454d-9173-8a85726aff75",
      "event_type": "device.connected",
      "created_at": "2022-08-24T11:14:36.796Z",
      "device_id": "65803a1c-866b-45ed-94d5-496b40e4cc4d",
      "workspace_id": "f97073eb-c003-467a-965b-e6dba3a0131d"
    }
  ],
  "ok": true
}

PreviousEvents NextGet an Event

Last updated 9 months ago

Was this helpful?