API Reference
Getting startedVisit een.comMy Application/Login

/vspVisits

get
https://{BaseUrl}/api/v3.0/vspVisits

Retrieve visit records with optional filtering by plate or event ID. Visit sessions are created by pairing LPR entry/exit events within a site location.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Filter by license plate number (exact match)

string

Filter by license plate number with fuzzy matching (up to 1 edit distance)

locationId__in
array of strings

Filter visits within specified location IDs

locationId__in
string

Find visit containing this entry or exit event ID

string

Token string value that references a page for pagination. This value is received when retrieving the first page in the nextPageToken and prevPageToken fields. When a pageToken is provided, the backend remembers search parameters from the original request, so search parameters that affect the result set or order are optional and will be ignored if provided. Representation parameters like include should still be applied.

integer
1 to 500
Defaults to 100

The number of entries to return per page. The maximum range of valid page sizes is documented with minimum and maximum values, but the range might be further limited dynamically based on the requested information, account, and system status. Values outside of the (dynamic) allowed range will not result in an error, but will be clamped to the nearest limit. Thus, logic to detect the last page should not be based on comparing the requested size with the received size, but on the existence of a nextPageToken value.

Responses

Updated 6 days ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 days ago