Skip to content

Capabilities#

In general, all locks support all API functionalilty. So you can call any endpoint with any lock. But, some locks behave in slightly different ways, or have slightly different capabilities. For example, all Yale locks have built-in keypads so they all support the PIN management endpoint. However, some can store 255 PINs while others can store 500.

When using the lock capabilities endpoint, keep these things in mind.

  • Locks have many capabilities and you will receive them all. Some capabilities apply only to the Yale Access app. The capabilities listed here are an abbreviated list that may apply to your use of locks with the API.
  • Some capabilities exist for all locks, like integratedDeadbolt. All locks either have or don't have an integrated deadbolt.
  • Some capabilities do not exist for all locks, like wifiFrequencies, because not all locks have integrated Wi-Fi.

Method and Path#

GET /devices/capabilities

Example#

Let's get the capabilities for a lock using it's lockID.

Request#

GET /devices/capabilities?deviceType=lock&deviceID=1234567890ABCDEF1234567890ABCDEF

x-august-api-key: <your API key>
x-august-access-token: <your user's access token>

These are the query string fields you can pass.

  • deviceType - Should be lock.
  • deviceID - The ID of the device. In this example, we're using the lockID of the lock.

Response#

{
  "lock": {
    "doorSense": true,
    "autoUnlock": true,
    "rtc": false,
    "pinSlotMin": 1,
    "pinSlotMax": 500,
    "pinLengthMax": 8,
    "pinLengthMin": 4,
    "supportsRFID": false,
    "supportsFingerprintCredential": false,
    "hasIntegratedWiFi": true,
    "wifiFrequencies": ["2.4"],
    "integratedDeadbolt": true,
    "integratedKeypad": true,
    "oneTouch": true,
    "wrongCode": true,
    "batteryType": "AA",
    "manufacturer": "Yale",
    "serialNumber": "YRD 410/420/430/450",
    "standalone": true,
    "type": 15,
  }
}
  • doorSense - A boolean, true if the lock supports DoorSense©.
  • autoUnlock - A boolean, true if the lock supports Auto-Unlock.
  • rtc - A boolean, true if the lock has a built-in real time clock (RTC). Locks without an RTC do not support recurring or temporary PINs.
  • pinSlotMin - An integer, indicating the lowest slot that a lock can load a PIN into. See the PIN management page for an explanation of how to use this and the pinSlotMax field to calculate how many PINs a lock can hold at once.
  • pinSlotMax - An integer, indicating the highest slot that a lock can load a PIN into.
  • pinLengthMax - An integer, indicating the maximum length a PIN can be. For locks with integrated or attached keypads.
  • pinLengthMin - An integer, indicating the minimum length a PIN can be. For locks with integrated or attached keypads.
  • supportsRFID - A boolean, true if the lock has an integrated RFID reader.
  • supportsFingerprintCredential - A boolean, true if the lock has an integrated fingerprint reader, like an Assure 2 Touch.
  • hasIntegratedWiFi - A boolean, true if the lock has integrated Wi-Fi, like an August Wi-Fi Smart Lock, and therefore does not need an external bridge to connect to the internet.
  • wifiFrequencies - An array of strings, indicating what Wi-Fi frequencies the lock supports, either 2.4 and/or 5.0.
  • integratedDeadbolt - A boolean, true if the lock has an integrated deadbolt, like an Assure 2 Touch. False if the lock is a retrofit lock, like an August Wi-Fi Smart Lock.
  • integratedKeypad - A boolean, true if the lock has an integrated keypad, like an Assure 2 Touch.
  • oneTouch - A boolean, true if the lock has a keypad that supports One-Touch Locking.
  • wrongCode - A boolean, true if the lock has a keypad that sends a log when someone enters an incorrect PIN.
  • batteryType - A string, indicating what type of batteries the lock uses, for example AA or CR123.
  • manufacturer - A string, indicating what company manufactured the lock, either yale or august.
  • serialNumber - A string, indicating the model number of the lock. This only exists for Yale locks.
  • standalone - A boolean, true if the lock is a standalone lock, like an Assure 2 Touch. False if the lock is actually a module in a separate host lock, such as a Wi-Fi Smart Module in an Assure Lock.
  • type - An integer, indicating the lock's type. Every lock has a unique type.