Jump to Content
API Reference
v0
Log In
API Reference
Log In
v0
API Reference
Fob Object
Search
All
Pages
Start typing to search…
JUMP TO
Basic
API Overview
Rate Limit
Authentication
Request Headers
General Error Codes
Authorization
Authorization
Create Authorization
post
Invalidate Authorization
del
Error Codes
Key Management
Key
Overview
Key Object
Create Key
post
Retrieve Key
get
Edit Key
put
Retire Key
del
Search Keys
get
Unlink Fob
put
Link Fob
put
Refresh Code
put
Error Codes
Fob
Fob Object
Retrieve Fob
get
Access
Access
Overview
Access Object
Create Access
post
Retrieve Access
get
Edit Access
put
Search Accesses
get
Resend Access
put
Cancel Access
del
Retrieve Access QR Code
get
Error Codes
Alias Code
Overview
Alias Object
Retrieve Alias Code
get
Create Alias Code
post
Search Alias Codes
get
Edit Alias Code
put
Remove Alias Code
del
Error Codes
User and Permission Management
Group
Overview
Group Object
Retrieve Group
get
Search Groups
get
Error Codes
Permission
Overview
Permission Object
Create Permission
post
Retrieve Permission
get
Search Permissions
get
Edit Permission
put
Delete Permission
del
Error Codes
User API: Private Beta
Location and Smartbox Management
Smartbox
Overview
Smartbox Object
Retrieve SmartBox
get
Search SmartBoxes
get
Edit SmartBox
put
Unlink SmartBox
put
Update Unlock Codes
put
Error Codes
Location
Overview
Location Object
Search Locations
get
Retrieve Location
get
Link SmartBox
put
Error Codes
Bin
Overview
Bin Object
Retrieve Bin
get
Search Bins
get
Add Key
put
Remove Key
put
Error Codes
Bin Release
Overview
Release Object
Create Release
post
Retrieve Release
get
Search Releases
get
Error Codes
Event and Webhook Notification
Overview
Event
Overview
Event Object
Search Events
get
Retrieve Event
get
Error Codes
Notification
Webhook Notification
Webhook
Webhook Object
Create Webhook
post
Retrieve Webhook
get
Search Webhooks
get
Edit Webhook
put
Delete Webhook
del
Error Codes
Organization
Organization Membership
Overview
Organization Membership Object
Create SmartBox User
post
Retrieve Organization Membership
get
Edit Organization Membership
put
Delete Organization Membership
del
Search Organization Memberships
get
Error Codes
Organization
Overview
Organization Object
Retrieve Organization
get
Search Organizations
get
Exchanges
Simulating Key Exchanges
Overview
Exchange Key
put
Exchange
Overview
Exchange Object
Create Exchange
post
Search Exchanges
get
Retrieve Exchange
get
Error Codes
Fob Object
Field
Type
Description
serialNumber
string
The serial number of the fob.
