Quickstart

The MyRemotely API gives an integration read-only access to active locks in one organization. The API key decides the organization. Do not send an organization ID in the URL or body.

Before you start

Ask an organization administrator for a key with the locks:read scope. It also permits the provider live state. Store the key in a secret manager. The key is shown only once when it is created or rotated.

Set the base URL for the environment that issued the key, then set the key:

export MYREMOTELY_BASE_URL='https://app.myremotely.ai'
export MYREMOTELY_API_KEY='mr_lock_REPLACE_WITH_YOUR_KEY'

List locks

Send the key in the x-api-key header. Do not put it in a query string.

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

The response contains safe lock fields and unit IDs. It does not contain passcodes, provider IDs, credentials, notes, or entry instructions.

{
  "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": null
}

Continue with the end-to-end lock guide, or open the lock detail reference and live-state guide.