Sign in

v1

latestOpenAPI 3.0.32026-07-24214879985.1 KB
VSP Visits

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.

get/vspVisits

Query parameters

platestring

Filter by license plate number (exact match)

plate__fuzzystring

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

locationId__instring[]

List of Location IDs to filter on that is comma separated.

[
  "2428fda3-389f-48ce-b062-85875dd6b2e2"
]
eventIdstring

Find visit containing this entry or exit event ID

pageTokenstring

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.

pageSizeinteger

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.

Response

List of visit records matching search criteria

nextPageTokenstring nullable required

Token to retrieve the next page. The value of this token is passed into the field pageToken. This value can be null if there is no next page.

prevPageTokenstring nullable required

Token to retrieve the previous page. The value of this token is passed into the field pageToken. This value can be null of there is no previous page.

totalSizeinteger nullable

The number of resource entries being returned from the result set. This can be omitted if the API endpoint does not have total size information.

Example response

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "accountId": "12345678",
      "locationId": "acd0dd1-05a0-4d75-a14b-30e0f4083c70",
      "plate": "ABC123",
      "entry": {
        "timestamp": "2026-01-09T08:30:00.000+00:00",
        "eventId": "f99e57ca-b6aa-4919-a0e6-73355cf18c9e",
        "cameraId": "100abcde"
      },
      "exit": {
        "timestamp": "2026-01-09T08:30:00.000+00:00",
        "eventId": "f99e57ca-b6aa-4919-a0e6-73355cf18c9e",
        "cameraId": "100abcde"
      },
      "durationSec": 6300,
      "state": "complete"
    }
  ]
}