Jobs for Lock (Bridge Proxied)

Bridge Proxied Jobs send commands to smart locks through a Bridge device. The Bridge acts as an intermediary that communicates with locks via Bluetooth while your application communicates with the Bridge via the API.

For endpoint request/response signatures, see the Bridge Jobs API Reference.

Job Creation

Create a job by making a POST request to:

/devices/{deviceId}/jobs/bridges/{bridgeId}

Request Parameters

Response

{
  "jobId": "string"
}

Job Types

Command Details

Lock

Locks the device and optionally synchronizes its internal clock.

{
  "jobType": 1,
  "jobData": {
    "lockTime": "2024-01-01T12:00:00+00:00"
  }
}

Unlock

Unlocks the device and optionally synchronizes its internal clock.

{
  "jobType": 2,
  "jobData": {
    "lockTime": "2024-01-01T12:00:00+00:00"
  }
}

Create Custom PIN Code

Creates a PIN code with specific access permissions and time restrictions.

Devices/locks supporting PIN are listed in Supported Devices.

PIN Types

{
  "jobType": 4,
  "jobData": {
    "accessName": "Guest PIN",
    "pin": "123456",
    "pinType": 4,
    "startDate": "2024-01-01T12:00:00+00:00",
    "endDate": "2024-01-01T16:00:00+00:00"
  }
}

One-Time PIN (24-hour validity):

{
  "jobType": 4,
  "jobData": {
    "accessName": "OTP PIN",
    "pin": "123456",
    "pinType": 1,
    "startDate": "2024-01-01T00:00:00+00:00"
  }
}

Delete PIN Code

Removes a PIN code from the lock. Unactivated algoPINs can only be deleted within one week of their start time.

{
  "jobType": 5,
  "jobData": {
    "pin": "123456"
  }
}

Get Battery Level

Retrieves the lock's current battery level as a percentage.

{
  "jobType": 9
}

Get Device Status

Queries the lock's current operational status.

{
  "jobType": 10
}

Get Activity Logs

Downloads activity logs from the lock. Optionally synchronizes the lock's clock. Activity logs are deleted from the lock after retrieval.

{
  "jobType": 15,
  "jobData": {
    "lockTime": "2024-01-01T12:00:00+00:00"
  }
}

Error Status Codes