Skip to main content
GET
/
lock-events
curl -H "X-API-Key: YOUR_API_KEY" \
  https://your-api-host/lock-events

{
  "events": [
    {
      "event_id": "evt_123",
      "hardware_id": "ABC123",
      "event": "unlock",
      "timestamp": "2025-12-17T10:30:00.000Z",
      "source": "rfid",
      "code": "ABC123"
    },
    {
      "event_id": "evt_124",
      "hardware_id": "ABC123",
      "event": "unlock",
      "timestamp": "2025-12-17T14:00:00.000Z",
      "source": "remote",
      "metadata": {
        "userId": "user_456",
        "name": "Jane Smith"
      }
    }
  ],
  "pagination": {
    "limit": 100,
    "offset": 0,
    "returned": 2
  }
}
Returns a paginated list of lock and unlock events. Results are automatically scoped to devices within your access.

​
Query parameters

​
hardware_id
string
Filter by device hardware ID.
​
source
string
Filter by event source: rfid, keypad, key, or remote.
​
event
string
Filter by event type: lock or unlock.
​
code
string
Find events by RFID tag or keypad code.
​
from
string
ISO 8601 date string (start of time range).
​
to
string
ISO 8601 date string (end of time range).
​
limit
number
default:"100"
Max results per page (1–1000).
​
offset
number
default:"0"
Pagination offset.

​
Response

​
events
object[]
required
Array of lock event objects.
​
pagination
object
required

​
Event sources

Sourcecode fieldmetadata fieldTriggered by
rfidRFID tag value—Device hardware
keypadCode entered—Device hardware
key——Physical key
remote—OptionalAPI command
curl -H "X-API-Key: YOUR_API_KEY" \
  https://your-api-host/lock-events

{
  "events": [
    {
      "event_id": "evt_123",
      "hardware_id": "ABC123",
      "event": "unlock",
      "timestamp": "2025-12-17T10:30:00.000Z",
      "source": "rfid",
      "code": "ABC123"
    },
    {
      "event_id": "evt_124",
      "hardware_id": "ABC123",
      "event": "unlock",
      "timestamp": "2025-12-17T14:00:00.000Z",
      "source": "remote",
      "metadata": {
        "userId": "user_456",
        "name": "Jane Smith"
      }
    }
  ],
  "pagination": {
    "limit": 100,
    "offset": 0,
    "returned": 2
  }
}