Events

Recent Channel activity can be fetched via the API. The default response is the last 50 events.

Pass a parameter n to change the number of events returned or since (as a date in ISO 8601 format) to return all events since that date.

List all events

> GET /api/3/events

Optional parameter filtering

Parameters	Notes
n	the number of events to be retuned
since	all events since the datestamp passed

> GET /api/3/events?n=10

> GET /api/3/events?since=2013-01-01T00:00:00

Please note that the above syntax will only include Activity Events (see reference below)

Retrieve an event

To obtain details for a single Event:

> GET /api/3/events/6455132

Example Response

{
    "id": 6455132,
    "event_code": 10,
    "event_label": "Admitted (Card/fob)",
    "channel_id": 1566,
    "channel_name": "Front Entrance",
    "credentials_number": "44455661215",
    "person_id": 455165,
    "person_name": "Joe Bloggs",
    "updated_at": "2023-09-07T13:18:38+01:00",
    "created_at": "2023-09-07T13:18:38+01:00",
}

---

Event code reference

Channel Status

Event Code	Meaning
1	Channel started
2	Channel stopped
3	Channel contact lost

---

Activity events

Event Code	Meaning
10	Admitted (Card/fob)
11	Admitted (PIN)
12	Admitted (Manual)
13	Admitted (Request Exit)
14	Admitted (Auxiliary)
20	Rejected (Unauthorised card/fob)
21	Rejected (Out of hours)
22	Rejected (Lock down)
23	Rejected (Tamper)
24	Rejected (Unauthorised PIN)
28	Rejected (Passback detected)
30	Request exit button pressed
31	Channel state normal
32	Channel state forced-open
33	Channel state extended-open
40	Automatic unlock shift started
41	Automatic unlock shift ended
90	Tamper detected

---

Perimeter events

Event Code	Meaning
31	Door state normal
32	Door state forced-open
33	Door state extended-open

---

Syncing

Event Code	Meaning
100	Channel sync started
101	Channel sync not required
105	Channel sync completed
106	Channel sync failed
107	Channel sync timing out