IntServ Access API
Search…
/events/list
​
https://api.intserv.se/v1/events/list
Fetches event history from the access control systems the integration has permission to. Events that indicates access granted and access denied is currenly supported.
Authentication Type: Integration API Key

​
πŸ“©
Request Body Parameters

Field
Type
Description
from_date
​
string
(optional) Start of time range of events to receive.
Default is 7 days from now.
to_date
​
string
(optional) End of time range of events to receive.
Default is now.
systems
string[]
(optional) An identifier for each access control system to filter on. If omitted, events from all systems will be included.
include_access_granted
boolean
(optional) true if events in the access granted category should be included, otherwise false.
include_access_denied
boolean
(optional) true if events in the access denied category should be included, otherwise false.
limit
​
int
(optional) The maximum number of events to return.
Default and max allowed is 1000 events.
continuation_key
string
(optional) Token returned in a previous response that can be used to return the next set of events.
If both include_access_granted and include_access_denied fields is omitted or is set to false in the request, this will be eqvivalent to not filtering on a event category at all.

Responses

​
βœ…
200 OK Response Body Parameters

Sample Response
Model Schema
{
"least_sync_time": "2020-03-01T00:00:00Z",
"has_more": false,
"continuation_key": null,
"events":
[
{
"event_time": "2020-03-01T00:00:00Z",
"sequence_id": 12345,
"category": "accessgranted",
"type": 101,
"system_id": "abc123-001",
"door_name": "entrance",
"key_id": "47c73793-ac07-4180-b660-438ca589c0b6",
"key":
{
"identification": "0001234567890",
"type": "proximity"
},
"person":
{
"id": "81bd075c-f97b-4576-96f5-9821c7d80e98",
"first_name": "first name",
"last_name": "last_name"
},
"subject": null
}
]
}
EventResponse {
least_sync_time (string),
has_more (boolean),
continuation_key (string),
events (array[Event])
}
​
Event {
event_time (string),
sequence_id (int),
category (string),
type (int),
system_id (string),
door_name (string),
key_id (string(uuid)),
key (AccessKey),
person (Person),
subject (Subject)
}
​
AccessKey {
identification (string),
type (string)
}
​
Person {
id (string(uuid)),
first_name (string),
last_name (string)
}
​
Subject {
name (string)
}

Event Response Model

Field
Type
Description
least_sync_time
​
string
​
Indicates until which point in time it is guaranteed that events has been synchronized for the access control systems in scope for the request.
has_more
boolean
Is true if there is more events that has not been returned yet, otherwise false. If true the continuation_key value can be used in subsequent requests to fetch the next set of events.
continuation_key
string
Token that can be used to fetch the next set of events (if any). null if there is no more events to fetch.
events
array[Event]
Array of the requested events.

Event Model

Field
Type
Description
event_time
string
The time of the event.
sequence_id
​
​
​
int
​
​
​
A sequence number that can be used to determine the order of the events originating from the same access control system. Guaranteed to be unique only in the scope of the same access control system and event_time value.
category
string
The category of events this event belongs to.
type
int
The type of event. See event types for more information.
system_id
string
Identifier of the access control system the event originates from.
door_name
string
Name of the door.
key_id
string(uuid)
Identifier of the access key or null. A null value typically indicates that the access key has not been created or imported into IntServ Access, or the event is not associated to an access key.
key
AccessKey
The access key used or nullif the event is not associated to an access key.
person
Person
The person associated to the event, or null.
subject
Subject
The subject (if the subject is not a person) associated to the event, or null.

AccessKey Model

Field
Type
Description
identification
string
The raw identification number (csn or code) of the access key.
type
string
The type of access key. See access keys for more information.

Person Model

Field
Type
Description
id
string(uuid)
Identifier of an existing person to assign the access key to.
first_name
string
The first name of the person.
last_name
string
The last name of the person.

Subject Model

Field
Type
Description
name
string
The name of the subject.
Copy link
On this page
Request Body Parameters
Responses