Get started with August Locks

Learn how to connect and control your August lock with the Seam API.


Seam provides a universal API to connect and control many brands of smart locks. This guide provides a rapid introduction to connecting and controlling your August lock using the Seam API. To learn more about other smart lock brands supported by Seam such as Yale, Schlage, and Salto, head over to our integration page.

1 — Install Seam SDK

Seam provides client libraries for many languages, such as JavaScript, Python, Ruby, PHP, and others, as well as a Postman collection and OpenAPI spec.

npm i seam

Once installed, sign-up for Seam to get your API key, and export it as an environment variable:

$ export SEAM_API_KEY=seam_test2ZTo_0mEYQW2TvNDCxG5Atpj85Ffw

This guide uses a Sandbox Workspace. Only virtual devices can be connected. If you need to connect a real August Lock, use a non-sandbox workspace and API key.

To control your August lock via the Seam API, you must first authorize your Seam workspace against your August account. To do so, Seam provides Connect Webviews: pre-built UX flows that walk you through authorizing your application to control your August lock.

Request a Connect Webview

from seamapi import Seam

seam = Seam()

webview = seam.connect_webviews.create(accepted_providers=["august"])

assert webview.login_successful is False

# Send the webview URL to your user

Authorize Your Workspace

Navigate to the URL returned by the Webview object. Since you are using a sandbox workspace, complete the login flow by entering the August sandbox test accounts credentials below:

  • email:

  • password: 1234

  • 2-factor-auth: 123456

Confirm the Connect Webview was successful by querying its status:

updated_webview = seam.connect_webviews.get(webview.connect_webview_id)

assert updated_webview.login_successful # true

3 — Retrieve August Lock Devices

After an August account is linked with Seam, you can retrieve devices for this August account. The Seam API exposes most of the device's properties such as battery level or door lock status.

all_locks = seam.locks.list()

some_lock = all_locks[0]

assert["online"] is True
assert["locked"] is True

# Device(device_id='9f237252-e182-49d6-9f32-464efb0a3519',
#    device_type='august_lock',
#    location=None,
#    properties={
#   'locked': False,
#    'online': True,
#    'door_open': False,
#    'manufacturer': 'august',
#    'battery_level': 0.9999532347993827,
#    'august_metadata': {'lock_id': 'lock-3', 'lock_name': 'GARAGE', 'has_keypad': True, 'house_name': 'My House'}, 'name': 'GARAGE'},
#    capabilities_supported=['access_code', 'lock'])

4 — Locking & Unlocking a Door

Next, you can perform the basic action of locking and unlocking the door.

Unlock a door


Request Body




# lock the door
updated_lock = seam.locks.get(some_lock.device_id)
assert["locked"] is True

# Now unlock the door
updated_lock = seam.locks.get(some_lock.device_id)
assert["locked"] is False

5 — Setting Access Code on August Lock

Some August locks also have a keypad paired to them to program access codes. These codes can then be entered to unlock an August lock.

The Seam API makes it easy to program both ongoing codes and timebound codes on an August lock. You can find out more about August lock access code in our core concept section on access codes.

# create an ongoing code
    device=some_lock, code="123456", name="Personal Access Code"

# create a timebound code
    name="My Temp Access Code",

# you can use a device or a device_id as the "device" parameter
# [
#   AccessCode(
#     access_code_id='af5272b1-2a49-4eb5-9388-2447fc7b5bd1',
#     type='ongoing',
#     code='123459'
#   ),
#   AccessCode(
#     access_code_id='8c2db4da-b137-4c08-a2c3-d611e6ff91b3',
#     type='timebound',
#     code='888888',
#     starts_at='2028-08-12T19:24:00.000Z',
#     ends_at='2028-08-13T19:24:00.000Z',
#   )
# ]

Next Steps

Now that you've completed this guide, you can try to connect a real August device. To do so, make sure to switch to a non-sandbox workspace and API key as real devices cannot be connected to sandbox workspaces.

In addition, if you'd like to explore other aspects of Seam, here is a list of helpful resources:

If you have any questions or want to report an issue, email us at

Last updated


Š Seam Labs, Inc. All rights reserved.