Jump to Content
API Documentation
Home
API Documents
API Documentation
Home
Help Center
Command
API Documents
Home
Help Center
Command
Home
API Documents
Webhook Models
All
Pages
Start typing to search…
JUMP TO
Verkada API Overview
Introduction
Example Use Cases
Quick Start Guide
Security Overview
Pagination
Rate Limiting
Response Codes
Service Regions
Using Legacy API Keys
API Tokens
API Login
Get API Token
post
Verkada Webhooks
Overview
Set up Webhooks
Authentication
Webhook Models
Camera Events Webhook Object
LPR Webhook Object
Access Events Webhooks
Sensor Events Webhook Object
New Alarms Webhook Object
Classic Alarms Webhook Object
Event-Based Webhooks
Verkada Helix API
Overview
Glossary
Setting Up Verkada Helix
Using Verkada Helix
Quick Start Guide
Square - POS
Shopify - POS
General Troubleshooting
Methods
Delete a Helix Event
del
Get a Helix Event
get
Update a Helix Event
patch
Create a Helix Event
post
Search a Helix Event
post
Delete a Helix Event Type
del
Get List of Helix Event Types
get
Update a Helix Event Type
patch
Create a Helix Event Type
post
Camera API
Events
Get Alerts
get
Analytics
Get Max People/Vehicle Counts
get
Get People/Vehicle Counts
get
Set Object Position MQTT Config
post
Get Occupancy Trend Data
get
Get Dashboard Widget Trend Data
post
LPR
Get seen license plates
get
Delete a License Plate of Interest
del
Get All License Plates of Interest
get
Update a License of Interest
patch
Create a License Plate of Interest
post
Delete the License Plates of Interest specified in the uploaded file.
del
Create the License Plates of Interest specified in the uploaded file.
post
Get Timestamps for a License Plate
get
Audio
Get Camera Audio Status
get
Update Camera Audio Status
post
CloudBackup
Get cloud backup settings for a certain camera.
get
Update cloud backup settings for a certain camera.
post
Devices
Get Camera Data
get
Get Occupancy Trends Cameras
get
Footage
Get Link to Footage
get
Get Thumbnail Image
get
Get Latest Thumbnail Image
get
Get Thumbnail Link
get
Get Streaming Token
get
Stream Footage (Live or Historical)
get
People
Delete a Person of Interest
del
Get All Person of Interest
get
Update a Person of Interest
patch
Create a Person of Interest
post
Access API
Access APIs Intro & Overview
Access API Guides
Access Users, Groups, and Credentials Guide
Access Doors and Scheduling Guide
Access Events Guide
Access Levels Guide
Access Scenarios Guide
Access Groups
Get All Access Groups
get
Delete Access Group
del
Get Access Group
get
Create Access Group
post
Remove User from Access Group
del
Add User to Access Group
put
Access User Information
Get All Access Users
get
Get Access Information Object
get
Activate BLE for Access User
put
Deactivate BLE for Access User
put
Set End Date for User
put
Remove Entry Code for User
del
Set Entry Code for User
put
Send Pass App Invite for User
post
Delete Profile Photo
del
Get Profile Photo
get
Upload Profile Photo
put
Activate Remote Unlock for User
put
Deactivate Remote Unlock for User
put
Set Start Date for User
put
Access Credentials
Delete Access Card
del
Add Card to User
post
Activate Access Card
put
Deactivate Access Card
put
Delete License Plate from User
del
Add License Plate to User
post
Activate License Plate
put
Deactivate License Plate
put
Delete MFACode from User
del
Add MFA Code to User
post
Access Levels
Get All Available Access Levels
get
Create Access Level
post
Delete Access Level
del
Get Access Level
get
Update Access Level
put
Add Access Schedule Event to Access Level
post
Delete Access Schedule Event on Access Level
del
Get Access Schedule Event Details
get
Update Access Schedule Event on Access Level
put
Access Doors
Unlock Door as Admin
post
Unlock Door as User
post
Get Doors
get
Access Door Exception Calendars
Get All Available Door Exception Calendars
get
Create Door Exception Calendar
post
Delete Door Exception Calendar
del
Get Door Exception Calendar
get
Update Door Exception Calendar
put
Add Exception to Door Exception Calendar
post
Delete Exception on Door Exception Calendar
del
Get Exception on Door Exception Calendar
get
Update Exception on Door Exception Calendar
put
Access Control Models
Access Information Object
Access Group Metadata Object
Access Group Object
Access Card Object
License Plate Object
Access Group Addition Object
All Access User Object
Door Information Object
Site Information Object
Access Level Object
Access Schedule Event Object
Door Exception Calendar Object
Door Exception Object
Recurrence Rule Object
Access Scenario Object
Events
Get Access Events
get
Access Scenarios
Get All Access Scenarios
get
Activate Access Scenario
post
Release Access Scenario
post
Core API
Audit Log
Get Audit Logs
get
Users
External ID Introduction
Delete User
del
Get User
get
Create User
post
Update User
put
Core User API Models
Command User Object
Sensor API
Alerts
Get Sensor Alerts
get
Data
Get Sensor Data
get
Guest API
Events
Get Guest Events for a Site
get
Create a Guest Event
post
Delete Event
del
Get Guest Event by ID
get
Hosts
Get Hosts for a Site
get
Approved Lists
Get Approved Lists
get
Add People to Approved Lists
patch
Remove People from Approved Lists
patch
Get Approved List Members
get
Reset Approved List
patch
Deny List
Delete a Guest deny list
del
Post Guest Deny List
post
Sites
Get Guest Sites
get
Visits
Get Guest visits
get
Guest Types
Get Guest Types for a Site
get
Classic Alarms API
Devices
Get Alarm Devices
get
Sites
Get Site Information
get
Viewing Station API
Devices
Get Viewing Station Devices
get
Webhook Models
Ask AI
