curl -H "X-API-Key: YOUR_API_KEY" \
https://your-api-host/lock-events
curl -H "X-API-Key: YOUR_API_KEY" \
"https://your-api-host/lock-events?hardware_id=ABC123&source=rfid"
{
"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
}
}
Lock Events
Query Lock Events
Query lock and unlock events across devices.
GET
/
lock-events
curl -H "X-API-Key: YOUR_API_KEY" \
https://your-api-host/lock-events
curl -H "X-API-Key: YOUR_API_KEY" \
"https://your-api-host/lock-events?hardware_id=ABC123&source=rfid"
{
"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
string
Filter by device hardware ID.
string
Filter by event source:
rfid, keypad, key, or remote.string
Filter by event type:
lock or unlock.string
Find events by RFID tag or keypad code.
string
ISO 8601 date string (start of time range).
string
ISO 8601 date string (end of time range).
number
default:"100"
Max results per page (1–1000).
number
default:"0"
Pagination offset.
Response
object[]
required
Array of lock event objects.
Show Lock event object
Show Lock event object
object
required
Event sources
| Source | code field | metadata field | Triggered by |
|---|---|---|---|
rfid | RFID tag value | — | Device hardware |
keypad | Code entered | — | Device hardware |
key | — | — | Physical key |
remote | — | Optional | API command |
curl -H "X-API-Key: YOUR_API_KEY" \
https://your-api-host/lock-events
curl -H "X-API-Key: YOUR_API_KEY" \
"https://your-api-host/lock-events?hardware_id=ABC123&source=rfid"
{
"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
}
}