Brivo API

apidocs.brivo.com · Security

Security OAuth2 Paid Physical Security Access Control Doors

Cloud-based physical access control API — manage sites, doors, users, credential groups, and access events. Unlock doors, grant/revoke access, pull audit logs, and automate onboarding/offboarding. AI-native documentation (llms.txt). Requires Brivo customer account.

Authentication

OAuth2 OAuth2 Authorization Code or Client Credentials flow. Requires a Brivo account and API credentials from your account manager. Tokens passed as Authorization: Bearer.

Sample Requests

GET List sites

List all physical sites in the Brivo account.

https://api.brivo.com/v1/api/v1/sites

Hover any highlighted part to learn what it does

Headers — extra info sent with the request

Authorization

Bearer YOUR_TOKEN

curl -X GET "https://api.brivo.com/v1/api/v1/sites" \
  -H "Authorization: Bearer YOUR_TOKEN"

import requests
headers = {
    "Authorization": "Bearer YOUR_TOKEN"
}
response = requests.get(
    "https://api.brivo.com/v1/api/v1/sites",
    headers=headers,
)
print(response.json())

const url = 'https://api.brivo.com/v1/api/v1/sites';

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

package main

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

func main() {
	targetURL := "https://api.brivo.com/v1/api/v1/sites"
	req, _ := http.NewRequest("GET", targetURL, nil)
	req.Header.Set("Authorization", "Bearer YOUR_TOKEN")

	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.brivo.com/v1/api/v1/sites")

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

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

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

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

PUT Unlock a door

Remotely unlock a specific door.

https://api.brivo.com/v1/api/v1/doors/{doorId}/unlock

Hover any highlighted part to learn what it does

Headers — extra info sent with the request

Content-Type	application/json
Authorization	Bearer YOUR_TOKEN

curl -X PUT "https://api.brivo.com/v1/api/v1/doors/{doorId}/unlock" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"

import requests
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer YOUR_TOKEN"
}
response = requests.put(
    "https://api.brivo.com/v1/api/v1/doors/{doorId}/unlock",
    headers=headers,
)
print(response.json())

const url = 'https://api.brivo.com/v1/api/v1/doors/{doorId}/unlock';

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

package main

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

func main() {
	targetURL := "https://api.brivo.com/v1/api/v1/doors/{doorId}/unlock"
	req, _ := http.NewRequest("PUT", targetURL, nil)
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("Authorization", "Bearer YOUR_TOKEN")

	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.brivo.com/v1/api/v1/doors/{doorId}/unlock")

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

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

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

<?php
$url = "https://api.brivo.com/v1/api/v1/doors/{doorId}/unlock";
$opts = ["http" => [
    "method" => "PUT",
    "header" => implode("\r\n", [
        "Content-Type: application/json",
        "Authorization: Bearer YOUR_TOKEN"
    ]),
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET List access events

Retrieve recent access events (who entered/exited which door and when).

https://api.brivo.com/v1/api/v1/events?sort=eventOccurred,desc&pageSize=10

Hover any highlighted part to learn what it does

Headers — extra info sent with the request

Authorization

Bearer YOUR_TOKEN

curl -X GET "https://api.brivo.com/v1/api/v1/events?sort=eventOccurred%2Cdesc&pageSize=10" \
  -H "Authorization: Bearer YOUR_TOKEN"

import requests
params = {
    "sort": "eventOccurred,desc",
    "pageSize": "10"
}
headers = {
    "Authorization": "Bearer YOUR_TOKEN"
}
response = requests.get(
    "https://api.brivo.com/v1/api/v1/events",
    params=params,
    headers=headers,
)
print(response.json())

const url = new URL('https://api.brivo.com/v1/api/v1/events');
url.searchParams.set('sort', 'eventOccurred,desc');
url.searchParams.set('pageSize', '10');

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

package main

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

func main() {
	baseURL, _ := url.Parse("https://api.brivo.com/v1/api/v1/events")
	q := baseURL.Query()
	q.Set("sort", "eventOccurred,desc")
	q.Set("pageSize", "10")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)
	req.Header.Set("Authorization", "Bearer YOUR_TOKEN")

	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.brivo.com/v1/api/v1/events")
uri.query = URI.encode_www_form({
  "sort" => "eventOccurred,desc",
  "pageSize" => "10"
})

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

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

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

<?php
$url = "https://api.brivo.com/v1/api/v1/events?" . http_build_query([
    "sort" => "eventOccurred,desc",
    "pageSize" => "10"
]);
$opts = ["http" => [
    "method" => "GET",
    "header" => implode("\r\n", [
        "Authorization: Bearer YOUR_TOKEN"
    ]),
]];
$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 active Brivo account — contact brivo.com for API credentials
OAuth2: exchange client_id + client_secret for access_token
Set Authorization: Bearer YOUR_TOKEN on all requests
AI-native docs: point your AI assistant to https://apidocs.brivo.com/llms.txt
Sandbox environment available for integration testing

Open documentation ↗