JUMP TOVerkada API OverviewIntroductionExample Use CasesQuick Start GuideSecurity OverviewPaginationRate LimitingResponse CodesService RegionsVerkada WebhooksOverviewSet up WebhooksAuthenticationWebhook ModelsNotification Webhook ObjectLPR Webhook ObjectSensor Alerts Webhook ObjectAlarm Webhook ObjectAccess Events WebhooksVerkada Helix APIOverviewGlossarySetting Up Verkada HelixUsing Verkada HelixQuick Start GuideSquare - POSShopify - POSGeneral TroubleshootingMethodsDelete a Helix EventdeleteGet a Helix EventgetUpdate a Helix EventpatchCreate a Helix EventpostSearch a Helix EventpostDelete a Helix Event TypedeleteGet List of Helix Event TypesgetUpdate a Helix Event TypepatchCreate a Helix Event TypepostCamera APIAlertsGet AlertsgetAnalyticsGet Dashboard Occupancy Trend DatagetGet Max People/Vehicle CountsgetGet People/Vehicle CountsgetSet Object Position MQTT ConfigpostGet Occupancy Trend DatagetLPRGet seen license platesgetDelete a License Plate of InterestdeleteGet All License Plates of InterestgetUpdate a License of InterestpatchCreate a License Plate of InterestpostGet Timestamps for a License PlategetAudioGet Camera Audio StatusgetUpdate Camera Audio StatuspostCloudBackupGet cloud backup settings for a certain camera.getUpdate cloud backup settings for a certain camera.postDevicesGet Camera DatagetFeaturesFootageGet Link to FootagegetGet Thumbnail ImagegetGet Latest Thumbnail ImagegetGet Thumbnail LinkgetGet Streaming TokengetStream Footage (Live or Historical)getPeopleDelete a Person of InterestdeleteGet All Person of InterestgetUpdate a Person of InterestpatchCreate a Person of InterestpostCore APIAudit LogGet Audit LogsgetUsersExternal ID IntroductionDelete UserdeleteGet UsergetCreate UserpostUpdate UserputCore User API ModelsCommand User Objectsensor APIAlertsGet Sensor AlertsgetDataGet Sensor Datagetguest APISitesGet Guest SitesgetVisitsGet Guest visitsgetAccess APIAccess APIs Intro & OverviewAccess API GuidesAccess Users, Groups, and Credentials GuideAccess Doors GuideAccess Events GuideAccess GroupsGet All Access GroupsgetDelete Access GroupdeleteGet Access GroupgetCreate Access GrouppostRemove User from Access GroupdeleteAdd User to Access GroupputAccess User InformationGet All Access UsersgetGet Access Information ObjectgetActivate BLE for Access UserputDeactivate BLE for Access UserputSet End Date for UserputRemove Entry Code for UserdeleteSet Entry Code for UserputSend Pass App Invite for UserpostActivate Remote Unlock for UserputDeactivate Remote Unlock for UserputSet Start Date for UserputAccess CredentialsDelete Access CarddeleteAdd Card to UserpostActivate Access CardputDeactivate Access CardputDelete License Plate from UserdeleteAdd License Plate to UserpostActivate License PlateputDeactivate License PlateputAccess DoorsUnlock Door as AdminpostUnlock Door as UserpostGet DoorsgetEventsGet Access EventsgetAccess Control ModelsAccess Information ObjectAccess Group Metadata ObjectAccess Group ObjectAccess Card ObjectLicense Plate ObjectAccess Group Addition ObjectAll Access User ObjectDoor Information ObjectSite Information Objectalarm APIDevicesGet Alarm DevicesgetSitesGet Site Informationgetviewing station APIDevicesGet Viewing Station DevicesgetAccess Group Metadata Object AttributeTypeDescriptiongroup_idString (Unique)The unique identifier of the Access Group managed by Verkada.nameString (Unique)The unique name of the Access Group provided by the customer. Sample Access Group Object JSON{ "group_id": "067cad27-74e8-4732-94ae-26e0a93fe857", "name": "Employee" }