Admit through channel (any person)
Requests immediate admission through a channel without specifying a person.
This creates an admission request that momentarily unlocks the door.
Returns an admission_request_id that can be used to track the status via GET /api/3/admission_requests/:id.
Only works when the channel is in normal mode (not in unlock mode).
/api/3/channels/{id}/admit
Authentication
This endpoint requires authentication:
Use an OAuth 2.0 access token in the Authorization header. This is the recommended authentication method for all integrations. OAuth provides automatic token expiration, granular permission scopes, detailed usage tracking, and per-integration revocation. Learn how to obtain an access token.
Header Format:
Authorization: Bearer YOUR_ACCESS_TOKEN
Required Scopes:
account.channel.admit
Parameters
Path Parameters
id
integer
Channel ID
Responses
Admission request accepted and queued
Response Fields
admission_request_id
integer
ID of the admission request (Event ID) for status tracking
eg. 123456789
status
string
Initial status of the admission request
eg. pending
Bad Request - Channel not in normal mode or request cannot be processed
Response Fields
id
integer
required
Unique identifier for the channel
eg. 1340
name
string
required
Name of the channel/door controller
eg. Front Door
mac_address
string
required
MAC address of the controller (format aa:bb:cc:dd:ee:ff)
eg. 00:11:22:33:44:55
status
string
required
Current connection status of the channel
unit
integer
required
Unit number for multi-channel controllers
eg. 1
model
string | null
Controller model number
eg. IPBR-2
model_long
string
Full descriptive model name
eg. 2 channel IP Controller
serial_number
string | null
Serial number of the controller
card_format
string | null
Card format configuration
pin_format
string | null
PIN format configuration
freescale_version
string | null
Freescale firmware version
pic_version
string | null
PIC firmware version
reader_device_class_name
string | null
Reader device class identifier
site_id
integer | null
ID of the site this channel belongs to
updated_at
string
Timestamp of last update
created_at
string
Timestamp of creation
sync
object
required
Synchronization status information
Show child attributes
status
string
required
Current sync status
last_sync_completed_at
string
required
Timestamp of last successful sync completion
lockdown
object | null
Lockdown mode configuration (null if not in lockdown)
Show child attributes
message
string
eg. Cards and PINs will be rejected
Lockdown status message
card_lockdown
object
Show child attributes
state
boolean
Whether card access is locked down
rex_lockdown
object
Show child attributes
state
boolean
Whether REX (Request to Exit) is locked down
aux_lockdown
object
Show child attributes
state
boolean
Whether auxiliary input is locked down
mode
object
required
Current operating mode of the channel
Show child attributes
description
string
required
Current mode
relock_at
string
Time when door will automatically relock (if in unlock mode)
change_stamp
string
Timestamp when mode was last changed
auto_unlock
object | null
Auto-unlock shift configuration (null if not configured)
Show child attributes
id
integer
Shift ID
name
string
Shift name
Unauthorized - Invalid or missing authentication
Response Fields
error
string
eg. unauthorized
error_description
string
eg. The access token is invalid
Forbidden - User does not have permission
Response Fields
error
string
eg. forbidden
error_description
string
eg. You are not authorized to access this resource
Not Found - Resource does not exist or is not an admission request event
Response Fields
error
string
eg. not_found
error_description
string
eg. The requested resource was not found
Internal Server Error
Response Fields
error
string
eg. internal_server_error
error_description
string
eg. An unexpected error occurred