Sign in
watch-lists

Retrieve watch list by ID

Use this method to retrieve a watch list by its ID.

get/watch-lists/{id}/

Path parameters

idinteger required

A unique integer value identifying this Watch list.

Response

idinteger required
created_datestring date-time required

Object creation date

modified_datestring date-time required

Object modification date

activeboolean

true if a watch list is enabled

namestring required

Short watch list name, up to 256 characters

commentstring

Extended description, up to 2048 characters

colorstring

Color of the object label in hex

notifyboolean

true if the notifications on the watch list enabled

acknowledgeboolean

Require manual acknowledgment of the events that match with the watch list

camera_groupsinteger[]

List of the camera groups used to monitor the watch list

face_thresholdnumber float nullable

Watch list face confidence threshold

body_thresholdnumber float nullable

Watch list body confidence threshold

car_thresholdnumber float nullable

Watch list car confidence threshold

ignore_eventsboolean

Events won't be created if set to True

send_events_to_external_vmsboolean

true if events matched with this watch list should be sent to an external VMS

active_afterstring date-time nullable
active_beforestring date-time nullable
recount_schedule_onstring date-time required
originstring

bit

collect_locationboolean

true to enable daily search for cards from this watch list

Changes

No recorded changes to this endpoint across all 1 revision of this API.