Skip to content

Activity#

Activity is the list of things you and other users have done on your locks. Examples of activity include locking/unlock the lock, opening/closing the door, adding/removing keypad PIN codes, or someone ringing the doorbell.

You can retrieve activity from a house or an individual lock. This is a good way to check for historical or near-recent activity.

Activity by House#

This endpoint will return activity for locks in a specific house.

  • On locks where you are a guest, you will only see your own activity.
  • On locks where you are an owner, you will see all user activity.
  • If the house has a doorbell and you are allowed access, you will see call activity.

Path#

GET /houses/:houseID/activity/:limit

Example Request#

curl -X PUT \
-H "x-august-api-key: $APIKEY" \
-H "x-august-access-token: $AUGTOKEN" \
-H "Content-Type: application/json" \
https://api-production.august.com/houses/000HOUSE0ID00000/activity/100

The API reference lists the request parameters and response fields for this endpoint.

Activity by Lock#

This endpoint will just return activity for a single lock. You need to be an owner on the lock to use this endpoint.

Path#

GET /locks/logs/:lockID/:startDateTime/:endDateTime

Example Request#

curl -X PUT \
-H "x-august-api-key: $APIKEY" \
-H "x-august-access-token: $AUGTOKEN" \
-H "Content-Type: application/json" \
https://api-production.august.com/locks/logs/000LOCK0ID00000/activity/1626134716955/1626138332099

The API reference lists the request parameters and response fields for this endpoint.