---
title: "GET /vspVisits"
method: GET
path: "/vspVisits"
tags: ["VSP Visits"]
---

# GET /vspVisits

`GET /vspVisits`

## Request

- Base URL: `https://api.cxxx.eagleeyenetworks.com/api/v3.0`
- URL: `https://api.cxxx.eagleeyenetworks.com/api/v3.0/vspVisits`
- Auth: HTTP bearer

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.

## Query parameters

- `plate` string
- `plate__fuzzy` string
- `locationId__in` string[]
- `eventId` string
- `pageToken` string
- `pageSize` integer

## Response `200`

List of visit records matching search criteria

- VspVisitsResult: Used to wrap results for a paginated response, containing information on how to retrieve further pages and, if available, the total number of results.
  - `nextPageToken` string, 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.
  - `prevPageToken` string, 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.
  - `totalSize` integer, 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.
  - `results` object[], required: The result set from a collection API call.
    - `id` string, uuid, required: Unique identifier for the visit record
    - `accountId` string, required: Account ID associated with the visit
    - `locationId` string, required: Location ID where the visit occurred
    - `plate` string, required: License plate number of the vehicle
    - `entry` VisitEvent: Details of an entry or exit event within a visit
      - `timestamp` string, date-time, required: Timestamp of the entry or exit event
      - `eventId` string, required: LPR event ID associated with this entry or exit
      - `cameraId` string, required: Camera ID that captured the entry or exit event
    - `exit` VisitEvent: Details of an entry or exit event within a visit
      - `timestamp` string, date-time, required: Timestamp of the entry or exit event
      - `eventId` string, required: LPR event ID associated with this entry or exit
      - `cameraId` string, required: Camera ID that captured the entry or exit event
    - `durationSec` integer, nullable: Duration of the visit in seconds
    - `state` 'complete' | 'inProgress' | 'incomplete', required: Visit state: - `complete`: Entry and exit events successfully paired - `inProgress`: Entry event recorded, awaiting matching exit - `incomplete`: Exit without matching entry, or entry timed out after 24 hours

## Other responses

- `400`: The supplied object is invalid. Error detail will contain the validation error.
- `401`: You are not authenticated. Please authenticate and try again.
- `403`: You have no permission to access the specified resource.
- `500`: Something went wrong in the server. Please try again.

---

[API](https://skmtc.dev/eagleeyenetworks/apis/vehicle-surveillance-package.md) - [All operations](https://skmtc.dev/eagleeyenetworks/apis/vehicle-surveillance-package/llms.txt) - [OpenAPI document](https://skmtc.dev/eagleeyenetworks/apis/vehicle-surveillance-package/revisions/dca15710fe10?raw)