Get admission request status
Returns the status of an admission request created via POST /api/3/channels/:id/admit or
POST /api/3/channels/:id/admit_person. Use this to track whether the admission was successful,
denied, or is still pending a response from the door controller.
/api/3/admission_requests/{id}
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
account.channel.admit.person
Parameters
Path Parameters
id
integer
Admission request ID (Event ID returned from admit/admit_person endpoints)
Responses
Admission request status retrieved successfully
Response Fields
id
integer
required
Unique identifier for the admission request (Event ID)
eg. 123456789
status
string
required
Current status of the admission request: - pending: Waiting for door controller response - admitted: Person successfully admitted (event codes 15, 16, 50) - denied: Access denied (event code 51) - offline: Door controller offline (event code 52) - timeout: No response received within 2 minutes
eg. admitted
channel_id
integer
required
ID of the channel (door controller)
eg. 1340
person_id
integer | null
ID of the person (null for general admit requests)
eg. 12345
requested_at
string
required
Timestamp when the admission was requested
eg. 2024-01-15T14:30:00.000Z
completed_at
string | null
Timestamp when the admission completed (null if still pending)
eg. 2024-01-15T14:30:02.500Z
door_controller
object
required
Information about the door controller
Show child attributes
id
integer
eg. 1340
Door controller ID
name
string
eg. Front Door
Door controller name
person
object | null
Information about the person (null for general admit or if person not found)
Show child attributes
id
integer
eg. 12345
Person ID
name
string
eg. John Doe
Person 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