User Guide

Welcome to the Yale / August API. Once you know how to OAuth with August, you'll be able to:

Features

• Get information about a user account, including:
  • Name
  • Phone
  • Email
  • Country and language code
• List a user's devices, like locks and wifi bridges.
• Get information about devices, including:
  • Whether a lock is locked or unlocked.
  • Whether a door is opened or closed, if the lock has DoorSense™ enabled.
• Lock or unlock a lock from your mobile app or web app.
• Load PIN codes on locks that have keypads.
• Retrieve the activity feed for a lock, including who operated the lock.
• Receive webhooks about events that have to do with users, locks, and wifi bridges.

Confidential

This documentation is confidential and only those who have signed an NDA with Yale / August (or if their company has signed such an NDA) should access these docs. Do not share this documentation with external parties.

Contact Us

We use Zendesk as a developer support platform.

• For API support use this form.
• For SDK support use this form.
• For feature requests use this form.

If you don't have access to Zendesk, reach out to your integration manager.