Jobs for Bridge (Bridge Targeted)

These jobs only target the Bridge device itself, and do not target any lock device.

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

Parameter	Type
jobType	integer, see Job Types for a full list

{
  "jobType": 10
}

Response

{
  "jobId": "string"
}

Job Types

Job Type	Number
Get Device Status	10

{
  "jobType": 10
}

Once the job completes, you receive a webhook with the result.

Status Code	Message (API Response)	Description	Applies To
400	Bad Request	The request was unacceptable, often due to a missing or invalid parameter (e.g., `<field>` is required).	All
401	Unauthorized	No valid API key or access token was provided in the request header.	All
402	Payment Required (Various Messages)	The API trial has ended or the payment method was declined. Please verify billing details.	All
403	Forbidden	The authenticated user does not have the necessary permissions (scopes) for this resource.	All
404	Not Found	The requested resource does not exist or the endpoint URL is incorrect.	All
405	Method Not Allowed	The HTTP method used is not supported by this endpoint.	All
406	Unable to contact bridge as it appears to be offline	Unable to contact the bridge. Ensure the physical hardware is powered on and connected.	All
415	Unsupported Media Type	The Content-Type header must be set to application/json.	N/A
429	Too many requests. Please try again after X seconds.	Rate limit exceeded. Maximum 1 request every 5 minutes.	All
500	Internal Server Error	An unexpected error occurred on our end. Please retry later or contact support.	All