---
title: "GET /lprVehicleLists"
method: GET
path: "/lprVehicleLists"
tags: ["LPR Vehicle Lists"]
---

# GET /lprVehicleLists

`GET /lprVehicleLists`

Fetches the available vehicleLists based on the filter

## Query parameters

- `actor` string[]
- `plate` string
- `name__contains` string
- `pageToken` string
- `pageSize` integer

## Response `200`

Fetches all the vehicle list that matches the filtering based on the query parameters. Only list properties are returned per list. The individual vehicle records within a list are not returned

- LprVehicleListResult — 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 — IDs of all the vehicle Lists that satisfy the query.
    - `name` string, required — User supplied name for the list
    - `enabled` boolean — Whether list is enabled
    - `notes` string — A verbose explanation of the vehicle list
    - `resourceFilter` ResourceFilter — List of actors against which filtering to happen (camera/location/account)
      - `actors` ActorFilter[] — List of the actors for which events are checked.
        - `id` string — The id of the thing that caused the event This can be camera or location ID. If not supplied for any entry in the array, it is taken to mean as the entire account.
        - `type` 'camera' | 'location', required — Type of actor that caused the event.
    - `id` string, required — Unique system generated id for list
    - `createTimestamp` string, date-time, required — Timestamp when this list created
    - `updateTimestamp` string, date-time, required — Timestamp when this list last updated
    - `createdByUserId` string, required — User id of the creator of the vehicle list
    - `vehicleCount` integer, required — Number of vehicles in the list

## 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.
- `404` — Referenced resource could not be found.
- `500` — Something went wrong in the server. Please try again.

---

[API](https://skmtc.net/eagleeyenetworks/apis/devices.md) · [All operations](https://skmtc.net/eagleeyenetworks/apis/devices/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/eagleeyenetworks/devices/revisions/df57313de545/schema)