Avigilon Alta (Openpath) API

api.openpath.com · Security

Security API Key Paid Physical Security Access Control Doors

Cloud-based access control API from Avigilon Alta (formerly Openpath) — manage entries, users, schedules, and access zones. Supports mobile credential, keycard, and PIN entry. Real-time events via webhooks. API/SDK included in Alta subscription.

Authentication

API Key API key from your Avigilon Alta / Openpath org settings. Pass as Authorization: Bearer YOUR_API_KEY.

Sample Requests

GET List entries (doors)

List all access-controlled entries (doors/gates) in the organisation.

https://api.openpath.com/v1/v1/orgs/{orgId}/entries

Hover any highlighted part to learn what it does

Headers — extra info sent with the request

Authorization

Bearer YOUR_API_KEY

curl -X GET "https://api.openpath.com/v1/v1/orgs/{orgId}/entries" \
  -H "Authorization: Bearer YOUR_API_KEY"

import requests
headers = {
    "Authorization": "Bearer YOUR_API_KEY"
}
response = requests.get(
    "https://api.openpath.com/v1/v1/orgs/{orgId}/entries",
    headers=headers,
)
print(response.json())

const url = 'https://api.openpath.com/v1/v1/orgs/{orgId}/entries';

const response = await fetch(url, {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  },
}); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	targetURL := "https://api.openpath.com/v1/v1/orgs/{orgId}/entries"
	req, _ := http.NewRequest("GET", targetURL, nil)
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.openpath.com/v1/v1/orgs/{orgId}/entries")

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)
req["Authorization"] = "Bearer YOUR_API_KEY"

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.openpath.com/v1/v1/orgs/{orgId}/entries";
$opts = ["http" => [
    "method" => "GET",
    "header" => implode("\r\n", [
        "Authorization: Bearer YOUR_API_KEY"
    ]),
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

POST Trigger door unlock

Remotely unlock a door or gate.

https://api.openpath.com/v1/v1/orgs/{orgId}/entries/{entryId}/unlock

Hover any highlighted part to learn what it does

Headers — extra info sent with the request

Content-Type	application/json
Authorization	Bearer YOUR_API_KEY

curl -X POST "https://api.openpath.com/v1/v1/orgs/{orgId}/entries/{entryId}/unlock" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

import requests
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer YOUR_API_KEY"
}
response = requests.post(
    "https://api.openpath.com/v1/v1/orgs/{orgId}/entries/{entryId}/unlock",
    headers=headers,
)
print(response.json())

const url = 'https://api.openpath.com/v1/v1/orgs/{orgId}/entries/{entryId}/unlock';

const response = await fetch(url, {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer YOUR_API_KEY'
  },
}); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	targetURL := "https://api.openpath.com/v1/v1/orgs/{orgId}/entries/{entryId}/unlock"
	req, _ := http.NewRequest("POST", targetURL, nil)
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("Authorization", "Bearer YOUR_API_KEY")

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.openpath.com/v1/v1/orgs/{orgId}/entries/{entryId}/unlock")

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Post.new(uri)
req["Content-Type"] = "application/json"
req["Authorization"] = "Bearer YOUR_API_KEY"

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.openpath.com/v1/v1/orgs/{orgId}/entries/{entryId}/unlock";
$opts = ["http" => [
    "method" => "POST",
    "header" => implode("\r\n", [
        "Content-Type: application/json",
        "Authorization: Bearer YOUR_API_KEY"
    ]),
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

Postman Setup Guide

Get Postman ↗

Requires an Avigilon Alta / Openpath subscription
Get API key from your org settings at openpath.com
Set Authorization: Bearer YOUR_API_KEY
Org ID found in your org settings URL
Webhooks available for real-time access events — configure at admin.openpath.com

Open documentation ↗