Jump to Content

API Documentation

Home API Documents

API Documentation Home Help Center Command

API Documents

Home Help Center Command

Home API Documents

All

Pages

Start typing to search…

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 Tokenpost

Verkada Webhooks

Overview
Set up Webhooks
Authentication
Webhook Models

Verkada Helix API

Overview
Glossary
Setting Up Verkada Helix
Using Verkada Helix
Quick Start Guide
- Square - POS
- Shopify - POS
General Troubleshooting
Methods

Camera API

Events
- Get Alertsget
Analytics
LPR
Audio
- Get Camera Audio Statusget
- Update Camera Audio Statuspost
CloudBackup
- Get cloud backup settings for a certain camera.get
- Update cloud backup settings for a certain camera.post
Devices
- Get Camera Dataget
- Get Occupancy Trends Camerasget
Footage
People

Core API

Audit Log
- Get Audit Logsget
Users
Core User API Models
- Command User Object

Sensor API

Alerts
- Get Sensor Alertsget
Data
- Get Sensor Dataget

Guest API

Deny List
- Delete a Guest deny listdel
- Post Guest Deny Listpost
Sites
- Get Guest Sitesget
Visits
- Get Guest visitsget
Guest Types
- Get Guest Types for a Siteget
Hosts
- Get Hosts for a Siteget

Access API

Access APIs Intro & Overview
Access API Guides
Access Groups
Access User Information
Access Credentials
Access Levels
Access Doors
Access Door Exception Calendars
Access Control Models
Events
- Get Access Eventsget
Access Scenarios

Classic Alarms API

Devices
- Get Alarm Devices get
Sites
- Get Site Informationget

Viewing Station API

Devices
- Get Viewing Station Devicesget

Get Site Information

get

https://{region}.verkada.com/alarms/v1/sites

Returns information about a list of alarm sites

Language

Credentials

URL

Click Try It! to start a request and see the response here!