Skip to content
API
On this pageParameters
Endpoints

List locks

Lists active locks owned by the API key organization in stable cursor order. Requires `locks:read`.

GET /v1/locks

Parameters

NameInRequiredTypeDescription
limitqueryNostringThe maximum number of locks to return, from 1 to 100.
cursorqueryNostringThe opaque nextCursor value from the previous page.

Request examples

Set MYREMOTELY_BASE_URL to the environment you intend to call.

bash
curl --fail-with-body \
  --header "x-api-key: $MYREMOTELY_API_KEY" \
  "$MYREMOTELY_BASE_URL/v1/locks?limit=20"

Responses

200 One cursor page of active locks.

application/json

FieldTypeRequiredDescription
dataarrayYesActive locks in this page.
nextCursoranyOfYesThe opaque cursor for the next page, or null when this is the last page.

Lock item fields

FieldMeaning
idPublic lock ID.
nameLock display name.
connectivityCached connectivity; not the live locked or unlocked state.
batteryLevelBattery percentage from 0 to 100.
lastOnlineAtLast online time, or null when unknown.
unitIdsPublic IDs of units bound to the lock.
createdAtLock record creation time.
updatedAtLast lock record update time.
json
{
  "data": [
    {
      "id": "lock_demo_01",
      "name": "Front door",
      "connectivity": "online",
      "batteryLevel": 87,
      "lastOnlineAt": "2026-09-16T12:00:00.000Z",
      "unitIds": [
        "unit_demo_01"
      ],
      "createdAt": "2026-09-15T12:00:00.000Z",
      "updatedAt": "2026-09-16T12:00:00.000Z"
    }
  ],
  "nextCursor": "string"
}

400 The list limit is outside the supported range or is not an integer.

application/problem+json

FieldTypeRequiredDescription
typestringYesA stable documentation URI for this problem.
titlestringYesA short problem title.
detailstringYesA safe explanation of this occurrence.
codestringYesA stable machine-readable problem code.
requestIdstringYesThe request ID to include when contacting MyRemotely support.
statusnumberYesThe HTTP status code.
json
{
  "type": "https://app.myremotely.ai/en/docs/errors#invalid-request",
  "title": "Invalid request",
  "status": 400,
  "detail": "The limit must be an integer from 1 to 100.",
  "code": "invalid_request",
  "requestId": "request_demo_01"
}

401 The API key is missing, invalid, expired, or revoked.

application/problem+json

FieldTypeRequiredDescription
typestringYesA stable documentation URI for this problem.
titlestringYesA short problem title.
detailstringYesA safe explanation of this occurrence.
codestringYesA stable machine-readable problem code.
requestIdstringYesThe request ID to include when contacting MyRemotely support.
statusnumberYesThe HTTP status code.
json
{
  "type": "https://app.myremotely.ai/en/docs/errors#invalid-api-key",
  "title": "Unauthorized",
  "status": 401,
  "detail": "Provide a valid API key.",
  "code": "invalid_api_key",
  "requestId": "request_demo_01"
}

403 The API key does not have the locks:read scope. | The public API channel or the operation's owning feature does not allow this use.

application/problem+json

json
"string"

404 The cursor is invalid or belongs to another organization.

application/problem+json

FieldTypeRequiredDescription
typestringYesA stable documentation URI for this problem.
titlestringYesA short problem title.
detailstringYesA safe explanation of this occurrence.
codestringYesA stable machine-readable problem code.
requestIdstringYesThe request ID to include when contacting MyRemotely support.
statusnumberYesThe HTTP status code.
json
{
  "type": "https://app.myremotely.ai/en/docs/errors#cursor-not-found",
  "title": "Not found",
  "status": 404,
  "detail": "The requested cursor was not found.",
  "code": "cursor_not_found",
  "requestId": "request_demo_01"
}

429 The API key request budget is exhausted.

application/problem+json

FieldTypeRequiredDescription
typestringYesA stable documentation URI for this problem.
titlestringYesA short problem title.
detailstringYesA safe explanation of this occurrence.
codestringYesA stable machine-readable problem code.
requestIdstringYesThe request ID to include when contacting MyRemotely support.
statusnumberYesThe HTTP status code.
json
{
  "type": "https://app.myremotely.ai/en/docs/errors#rate-limited",
  "title": "Too many requests",
  "status": 429,
  "detail": "Try the request again later.",
  "code": "rate_limited",
  "requestId": "request_demo_01"
}

500 MyRemotely could not complete the request.

application/problem+json

FieldTypeRequiredDescription
typestringYesA stable documentation URI for this problem.
titlestringYesA short problem title.
detailstringYesA safe explanation of this occurrence.
codestringYesA stable machine-readable problem code.
requestIdstringYesThe request ID to include when contacting MyRemotely support.
statusnumberYesThe HTTP status code.
json
{
  "type": "https://app.myremotely.ai/en/docs/errors#internal-error",
  "title": "Internal error",
  "status": 500,
  "detail": "The request could not be completed.",
  "code": "internal_error",
  "requestId": "request_demo_01"
}

Last updated Nov 3, 2026