Skip to content

UniFi Access API Docs

Main Navigation Detailed Docs API Quick Search Usage

English

English

Appearance

Sidebar Navigation

Guides

Overview

Introduction

Usage Guide

Changelog

Detailed Docs

User

Visitor

Access Policy

Credential

Space

Device

System Log

UniFi Identity

Notification

API Server

/api/v1/developer

/users

GET Fetch All Users

POST User Registration

/{id}

GET Fetch User

PUT Update User

DELETE Delete User

/access_policies

GET Fetch Access Policies Assigned to User

PUT Assign Access Policy to User

/nfc_cards

PUT Assign NFC Card to User

/delete

PUT Unassign NFC Card from User

/pin_codes

PUT Assign PIN Code to User

DELETE Unassign PIN Code from User

/license_plates

PUT Assign License Plate Numbers to User

/avatar

POST Upload User Profile Picture

/identity/assignments

GET Fetch Resources Assigned to Users

POST Assign Resources to Users

/search

GET Search Users

/{user_id}

/touch_passes/{touch_pass_id}

PUT Assign Touch Pass to User

DELETE Unassign Touch Pass from User

/license_plates/{license_plate_id}

DELETE Unassign License Plate from User

/touch_passes/assign

PUT Batch Assign Touch Passes to Users

/identity

/invitations

POST Send Identity Invitations

/assignments

GET Fetch Available Resources

/user_groups

GET Fetch All User Groups

POST Create User Group

/{id}

GET Fetch User Group

PUT Update User Group

DELETE Delete User Group

/users

GET Fetch Users in User Group

POST Assign User to User Group

/delete

POST Unassign User from User Group

/all

GET Fetch All Users in User Group

/access_policies

GET Fetch Access Policies Assigned to User Group

PUT Assign Access Policy to User Group

/identity/assignments

GET Fetch Resources Assigned to User Groups

POST Assign Resources to User Groups

/visitors

GET Fetch All Visitors

POST Create Visitor

/{id}

GET Fetch Visitor

PUT Update Visitor

DELETE Delete Visitor

/nfc_cards

PUT Assign NFC Card to Visitor

/delete

PUT Unassign NFC Card from Visitor

/pin_codes

PUT Assign PIN Code to Visitor

DELETE Unassign PIN Code from Visitor

/qr_codes

PUT Assign QR Code to Visitor

DELETE Unassign QR Code from Visitor

/license_plates

PUT Assign License Plates to Visitor

/{visitor_id}/license_plates/{license_plate_id}

DELETE Unassign License Plate from Visitor

/access_policies

GET Fetch All Access Policies

POST Create Access Policy

/{id}

GET Fetch Access Policy

PUT Update Access Policy

DELETE Delete Access Policy

/holiday_groups

GET Fetch All Holiday Groups

POST Create Holiday Group

/{id}

GET Fetch Holiday Group

PUT Update Holiday Group

DELETE Delete Holiday Group

/schedules

GET Fetch All Schedules

POST Create Schedule

/{id}

GET Fetch Schedule

PUT Update Schedule

DELETE Delete Schedule

/credentials

/pin_codes

POST Generate PIN Code

/nfc_cards

/sessions

POST Enroll NFC Card

/{id}

GET Fetch NFC Enrollment Status

DELETE Remove NFC Enrollment Session

/tokens

/{token}

GET Fetch NFC Card

PUT Update NFC Card

DELETE Delete NFC Card

GET Fetch All NFC Cards

/import

POST Import Third-Party NFC Cards

/touch_passes

GET Fetch Touch Pass List

POST Purchase Touch Passes

/search

GET Search Touch Pass

/assignable

GET Fetch Assignable Touch Passes

/{id}

GET Fetch Touch Pass Details

PUT Update Touch Pass

/qr_codes/download/{visitor_id}

GET Download QR Code Image

/door_groups

/topology

GET Fetch Door Group Topology

GET Fetch All Door Groups

POST Create Door Group

/{id}

GET Fetch Door Group

PUT Update Door Group

DELETE Delete Door Group

/doors

/{id}

GET Fetch Door

/unlock

PUT Remote Door Unlocking

/lock_rule

GET Fetch Door Locking Rule

PUT Set Temporary Door Locking Rule

GET Fetch All Doors

/settings/emergency

GET Fetch Door Emergency Status

PUT Set Door Emergency Status

/devices

GET Fetch Devices

/{device_id}

/settings

GET Fetch Device Access Method Settings

PUT Update Device Access Method Settings

/doorbell

POST Trigger Doorbells

/notifications

GET Fetch Notifications [WebSocket]

/system

/logs

POST Fetch System Logs

/export

POST Export System Logs

/resource/{id}

GET Fetch Resources in System Logs

/static/{path}

GET Fetch Static Resources

/webhooks/endpoints

GET Fetch Webhook Endpoints List

POST Add Webhook Endpoints

/{id}

PUT Update Webhook Endpoints

DELETE Delete Webhook Endpoints

/api_server/certificates

POST Upload HTTPS Certificate

DELETE Delete HTTPS Certificate

Generate PIN Code

POST

/api/v1/developer/credentials/pin_codes

Authorizations

bearerAuth

Type

HTTP (bearer)

Responses

Successful response

Content-Type

application/json

JSON

{

"code": "string",

"msg": "string",

"data": "string"

}

POST

/api/v1/developer/credentials/pin_codes

Playground

Server

Authorization

bearerAuth

Samples

Powered by VitePress OpenAPI

Pager

Previous page DELETE Delete Schedule

Next page POST Enroll NFC Card