Jump to Content

Guides API Reference

v0

API Reference

v0

All

Pages

Start typing to search…

Keycafe API

Keycafe API

Authentication

Authenticationpost

Authorization

Authorization
Create Authorizationpost
Invalidate Authorizationdelete
Error Codes

Key

Key
Key Object
Create Keypost
Retrieve Keyget
Search Keysget
Edit Keyput
Link Fobput
Unlink Fobput
Refresh Codeput
Retire Keydelete
Error Codes

Access

Access
Access Object
Create Accesspost
Retrieve Accessget
Search Accessesget
Retrieve Access QR Codeget
Edit Accessput
Resend Accessput
Cancel Accessdelete
Error Codes

Exchange

Exchange
Exchange Object
Create Exchangepost
Retrieve Exchangeget
Search Exchangesget
Error Codes

Event

Event
Event Object
Retrieve Eventget
Search Eventsget
Error Codes

Notifications

Webhook Notifications

Simulating Key Exchanges

Simulating
Exchange Keyput

Location

Location
Location Object
Retrieve Locationget
Search Locationsget
Link SmartBoxput
Error Codes

SmartBox

SmartBox
SmartBox Object
Retrieve SmartBoxget
Search SmartBoxesget
Edit SmartBoxput
Unlink SmartBoxput
Update Unlock Codesput
Error Codes

Bin

Bin
Bin Object
Retrieve Binget
Search Binsget
Add Keyput
Remove Keyput
Error Codes

Bin Releases

Release
Release Object
Create Releasepost
Retrieve Releaseget
Search Releasesget
Error Codes

Alias Code

Alias Code
Alias Code Object
Retrieve Alias Codeget
Create Alias Codepost
Search Alias Codesget
Edit Alias Codeput
Remove Alias Codedelete
Error Codes

Fob

Fob
Fob Object
Retrieve Fobget

Webhook

Webhook
Webhook Object
Create Webhookpost
Retrieve Webhookget
Search Webhooksget
Edit Webhookput
Delete Webhookdelete
Error Codes

USER

User API: Private Beta

Organization

Organization
Organization Object
Retrieve Organizationget
Search Organizationsget

Group

Group
Group Object
Retrieve Groupget
Search Groupsget
Error Codes

Organization Membership

Organization Membership
Organization Membership Object
Create SmartBox Userpost
Retrieve Organization Membershipget
Search Organization Membershipsget
Edit Organization Membershipput
Delete Organization Membershipdelete
Error Codes

Permission

Permission
Permission Object
Create Permissionpost
Retrieve Permissionget
Search Permissionsget
Edit Permissionput
Delete Permissiondelete
Error Codes

Webhook

Webhook information is made available via the RESTful endpoint: https://www.keycafe.com/v0/webhook