Get current account details
Returns the account information for the authenticated user
/api/3/account
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
Responses
Account details retrieved successfully
Response Fields
id
string
required
Unique hashid identifier for the account
eg. abc123xyz
name
string
required
Name of the account
eg. Acme Corporation
time_zone
string
required
Account's time zone (IANA time zone database format)
eg. America/New_York
monitored
boolean
required
Whether the account is being monitored
eg. true
reseller
object | null
Reseller information if account has an associated reseller
Show child attributes
id
integer
Reseller ID
name
string
Reseller name
support_contact
string
Support contact name
support_email
string
Support email address
support_telephone
string
Support telephone number
sync
object
required
Synchronization status information
Show child attributes
status
string
required
Current sync status
last_sync
string
required
Timestamp of last sync initiation
description
string
Detailed description of sync status (e.g., "2 of 5 failed")
user
object
required
Current authenticated user information
Show child attributes
id
integer
required
User ID
first_name
string
required
User's first name
last_name
string
required
User's last name
email
string
required
User's email address
passport
object
required
Mobile access features configuration
Show child attributes
remote_unlock_enabled
boolean
required
Whether passport remote unlock is enabled
hid_mobile_access
boolean
required
Whether HID mobile access is configured
Unauthorized - Invalid or missing authentication
Response Fields
error
string
required
Error code
eg. unauthorized
error_description
string
required
Human-readable error description
eg. The access token is invalid
Forbidden - User does not have permission
Response Fields
error
string
required
Error code
eg. unauthorized
error_description
string
required
Human-readable error description
eg. The access token is invalid
Mentioned in Guides
This endpoint is used in the following guides:
Your First API Request
Get up and running with your first DoorFlow API request in under 5 minutes
Quickstart Guide
Get from zero to granting door access in 15 minutes with this complete workflow
OAuth Authorization Flow
Complete OAuth 2.0 setup from testing to production in 15 minutes