--- title: "GET /lprVehicleLists:search" method: GET path: "/lprVehicleLists:search" tags: ["LPR Vehicle Lists"] --- # GET /lprVehicleLists:search `GET /lprVehicleLists:search` Fetches the vehicle records that match search criteria, across all the lists that match the search criteria ## Query parameters - `plate` string - `actor` string[] - `name__contains` string - `accessType__in` AccessType1[] - `securityStatus__in` SecurityStatus[] - `userData` object - `userTags__in` string[] - `userTags__contains` string - `pageToken` string - `pageSize` integer ## Response `200` Vehicle records that match the search criteria. - LprVehicleListsSearchResult — 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. - `validFrom` string, date, nullable — Date from which this record is valid - `validTo` string, date, nullable — Date upto which this record is valid - `schedule` object, nullable — It signifies a week long alert schedule. This schedule is effective according to actor's (user/camera/account) timezone. It allows setting different times for different days. - `sunday` Interval[], required - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `monday` Interval[], required - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `tuesday` Interval[], required - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `wednesday` Interval[], required - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `thursday` Interval[], required - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `friday` Interval[], required - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `saturday` Interval[], required - `start` string, required — Starting point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for a day - `end` string, required — End point of the interval. It should be in the range of 00:00 to 23:59 since this is the range for the day - `accessType` 'allow' | 'deny', required - `securityStatus` 'hotlist' | 'exempted' — Indicates whether vehicle is * hotlist: Vehicle flagged for tracking * exempted: Vehicle is exempt from watchlist rule and other rules. This is useful, for instance, when an organization wishes to avoid alerts on known vehicles, like employee vehicles. * none: Empty value provided when no special consideration for the vehicle - `userData` UserDataLpr — Object containing all user information associated with the specific event. For example, for a plate read, this would contain user supplied attributes for the given plate like apartment number. the following are the guidelines for supplying User Data: * It is recommended to use camelCase for field names, but this is not required * Maximum of 5 unique keys. * Each key or value should have only 256 characters max. * The keys 'type' and 'creatorId' are reserved keys. - `userTags` string[] — Tags containing all user information associated with the specific vehicle entry. * Maximum of 10 Tags per vehicle. * Each Tag should have only 256 characters max. - `color` 'beige' | 'black' | 'blue' | 'brown' | 'burgundy' | 'gold-beige' | 'green' | 'gray' | 'silver' | 'silver-gray' | 'maroon' | 'orange' | 'pink' | 'purple' | 'red' | 'teal' | 'white' | 'yellow' — Enumerations of standard colors for vehicles. - `model` string — Name of the vehicle model as defined by the manufacturer. Meant to be machine parsable, so should be in `lowerCamelCase` without spaces. - `make` 'abarth' | 'acura' | 'alfa_romeo' | 'aston_martin' | 'audi' | 'bentley' | 'bmw' | 'bugatti' | 'buick' | 'byd' | 'cadillac' | 'chevrolet' | 'chrysler' | 'citroen' | 'dacia' | 'daihatsu' | 'dodge' | 'dodge_ram' | 'ferrari' | 'fiat' | 'fisker' | 'ford' | 'ford_mustang' | 'garia' | 'genesis' | 'gmc' | 'harley_davidson' | 'honda' | 'hummer' | 'hyundai' | 'infiniti' | 'isuzu' | 'jaguar' | 'jeep' | 'kia' | 'lamborghini' | 'land_rover' | 'lexus' | 'lincoln' | 'lotus' | 'lucid' | 'mahindra' | 'maruti_suzuki' | 'maserati' | 'mazda' | 'mclaren' | 'mercedes_benz' | 'mini_cooper' | 'mitsubishi' | 'mg' | 'nissan' | 'oldsmobile' | 'opel' | 'perodua' | 'peugeot' | 'plymouth' | 'polaris' | 'polestar' | 'pontiac' | 'porsche' | 'proton' | 'ram' | 'renault' | 'rivian' | 'rolls_royce' | 'rover' | 'saab' | 'saturn' | 'scion' | 'skoda' | 'smart' | 'subaru' | 'suzuki' | 'tata' | 'tesla' | 'toyota' | 'vinfast' | 'volkswagen' | 'volvo' | 'wagoneer' | 'others' — Enumerations of standard makes/brands for vehicles. - `plate` string, required — License plate number of the vehicle in uppercase - `id` string, required — Unique system generated id for record - `createTimestamp` string, date-time, required — Timestamp when this record created - `updateTimestamp` string, date-time — Timestamp when this record last updated - `listId` string, uuid, required — Id of the list this record belongs to ## 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)