---
title: "Describe a wireless lock"
method: GET
path: "/orgs/{orgId}/wirelessLocks/{wirelessLockId}"
tags: ["orgs/wirelessLocks"]
---

# Describe a wireless lock

`GET /orgs/{orgId}/wirelessLocks/{wirelessLockId}`

__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:w,o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-admin:w,o{params.orgId}-admin:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeWirelessLock

## Path parameters

- `orgId` integer, required
- `wirelessLockId` integer, required

## Response `200`

Successful

- object
  - `data` object
    - `id` number, required
    - `name` string
    - `manufacturer` string
    - `model` string
    - `serialNumber` string, nullable
    - `idExt` string, nullable
    - `lastConnectedAt` string, date, nullable
    - `doorFileLastSyncedAt` string, date, nullable
    - `auditsLastSyncedAt` string, date, nullable
    - `linkId` string, nullable
    - `config` object, nullable
      - `battV` object
        - `main` string
        - `li` string
      - `fwVer` object
        - `lock` string
        - `main` string
        - `mainBl` string
        - `credRdr` string
        - `credRdrBl` string
        - `ble` string
        - `wifi` string
        - `macAdr` string
        - `recoveryFwVer` string
      - `lockPrmtrs` object
        - `name` string
        - `type` 'strm' | 'office' | 'apt' | 'prvcy'
        - `relock` integer
        - `lockId` integer
        - `doorProp` integer
        - `ada` integer
        - `firstManIn` 0 | 1
        - `battFail` 'asIs' | 'safe' | 'sec'
        - `blinkIntLed` 'T' | 'F'
        - `rapidBlink` 'T' | 'F'
        - `dstEnable` 0 | 1
        - `dstStart` string
        - `dstEnd` string
        - `rtcTime` string
        - `wifiAlertEn` 'T' | 'F'
        - `wifiAlertSel` string[]
        - `fwUrl` string
        - `fwDwnldTm` string
        - `fwImplTm` string
        - `dpsEn` 'T' | 'F'
        - `bleCredEn` 'T' | 'F'
        - `bleCredRng` 'short' | 'long'
        - `blePerf` 'norm' | 'max'
        - `invCrdAudEn` 'T' | 'F'
        - `wifiDwnldRtyTmIntv` integer
        - `wifiDwnldRtyCnt` integer
        - `auditIDEn` 'T' | 'F'
        - `blkCnstr` 'T' | 'F'
        - `mdl` string
        - `lckMode` string
        - `lckSn` string
        - `mainSn` string
        - `hwVer` string
        - `daysInUse` integer
        - `mfgDt` string
        - `dbDwnldTm` string
        - `fwImpTm` string
        - `nxtDbVerTS` string
        - `hwCfg` string
        - `dbUpdateStatus` integer
        - `wtyAct` string
        - `numCycles` integer
      - `rdrPrmtrs` object
        - `bprEn` 'T' | 'F'
        - `rdrSense` 'norm' | 'high' | 'max'
        - `proxConfHID` 'T' | 'F'
        - `proxConfGECASI` 'T' | 'F'
        - `proxConfGE4001` 'T' | 'F'
        - `proxConfGE4002` 'T' | 'F'
        - `proxConfAWID` 'T' | 'F'
        - `uid14443` 'T' | 'F'
        - `mi14443` 'T' | 'F'
        - `mip14443` 'T' | 'F'
        - `noc14443` 'T' | 'F'
        - `uid15693` 'T' | 'F'
        - `iClsUID40b` 'T' | 'F'
        - `iClsFrmt` 'disbld' | '64bCSN'
        - `daysInUse` integer
        - `sn` string
        - `hwVer` string
        - `mfgDt` string
        - `configCrdPrsntd` 'T' | 'F'
        - `customKeyPrsntd` 'T' | 'F'
      - `dvcProfile` object
        - `baseType` string
        - `ext` object[]
          - `key` string
          - `value` 1 | 0
    - `status` object, nullable
      - `lockStatus` object
        - `currentLockState` string
      - `sensorStatus` object
        - `locked` 'T' | 'F'
        - `auxPosition` 'T' | 'F'
        - `alarmPosition` 'T' | 'F'
        - `lockClutched` 'T' | 'F'
        - `primaryBatteryStatus` string
        - `rtcBatteryStatus` string
        - `rtccStatus` string
        - `doorOpen` 'T' | 'F'
        - `ipbActive` 'T' | 'F'
        - `rexActive` 'T' | 'F'
        - `renActive` 'T' | 'F'
        - `relActive` 'T' | 'F'
        - `deadBoltExtended` 'T' | 'F'
        - `keyOverrideActive` 'T' | 'F'
        - `fdrActive` 'T' | 'F'
        - `tamperOpen` 'T' | 'F'
        - `magTamperDetected` 'T' | 'F'
        - `rdrTamperDetected` 'T' | 'F'
        - `ttl1Active` 'T' | 'F'
        - `ttl2Active` 'T' | 'F'
        - `bprActive` 'T' | 'F'
        - `ledActive` 'T' | 'F'
    - `noTourLockId` integer, nullable
    - `commStatus` string, nullable
    - `batteryLevel` number, nullable
    - `isOffline` boolean
    - `thirdPartyDeviceId` integer, nullable
    - `thirdPartyDevice` object, nullable
      - `id` integer, required
      - `assignedOrg` object
        - `id` integer, required
        - `name` string
      - `serialNumber` string
      - `isOpSourced` boolean
      - `orderName` string, nullable
      - `createdAt` string, date
      - `updatedAt` string, date
      - `thirdPartyDeviceType` object
        - `id` number, required
        - `manufacturerName` string
        - `hardwareModel` string
        - `description` string
        - `dbModelName` string
        - `createdAt` string, date
        - `updatedAt` string, date
    - `acuId` integer, nullable
    - `acu` object, nullable
      - `id` integer, required
      - `opal` string
      - `locationRestriction` object, nullable
        - `id` number
        - `allowedDistanceMeters` number
        - `scaleFactor` number
        - `locationMeasurement` object
          - `id` number, required
          - `longitude` number
          - `latitude` number
          - `accuracyMeters` number, nullable
          - `timeZoneId` string, nullable
          - `locationMeasurementSourceType` object
            - `id` number, required
            - `name` string
            - `code` string
          - `rawData` object
    - `virtualAcuId` integer, nullable
    - `wirelessLockGatewayId` integer, nullable
    - `wirelessLockGateway` object, nullable
      - `id` number, required
      - `name` string
      - `manufacturer` string
      - `serialNumber` string
      - `model` string
      - `lastConnectedAt` string, date, nullable
      - `lastDisconnectedAt` string, date, nullable
      - `isLive` boolean, nullable
      - `idExt` string
      - `authKey` string, nullable
      - `acuId` integer
      - `acu` object
        - `id` integer, required
        - `opal` string
        - `locationRestriction` object, nullable
          - `id` number
          - `allowedDistanceMeters` number
          - `scaleFactor` number
          - `locationMeasurement` object
            - `id` number, required
            - `longitude` number
            - `latitude` number
            - `accuracyMeters` number, nullable
            - `timeZoneId` string, nullable
            - `locationMeasurementSourceType` object
              - …
            - `rawData` object
      - `config` object, nullable
      - `thirdPartyDeviceId` integer
      - `thirdPartyDevice` object
        - `id` integer, required
        - `assignedOrg` object
          - `id` integer, required
          - `name` string
        - `serialNumber` string
        - `isOpSourced` boolean
        - `orderName` string, nullable
        - `createdAt` string, date
        - `updatedAt` string, date
        - `thirdPartyDeviceType` object
          - `id` number, required
          - `manufacturerName` string
          - `hardwareModel` string
          - `description` string
          - `dbModelName` string
          - `createdAt` string, date
          - `updatedAt` string, date
      - `wirelessLockCount` integer
      - `wirelessLockProvider` object
        - `id` number, required
        - `siteIdExt` string, nullable
        - `siteAuthKey` string, nullable
        - `createdAt` string, date
        - `updatedAt` string, date
        - `orgId` number
        - `wirelessLockProviderType` object
          - `id` number, required
          - `name` string
      - `wirelessLockProviderId` integer
    - `wirelessLockProviderId` integer
    - `wirelessGatewayId` integer, nullable
    - `wirelessGateway` object, nullable
      - `id` number, required
      - `name` string
      - `manufacturer` string
      - `serialNumber` string
      - `model` string
      - `lastConnectedAt` string, date, nullable
      - `lastDisconnectedAt` string, date, nullable
      - `isLive` boolean, nullable
      - `idExt` string
      - `authKey` string, nullable
      - `acuId` integer
      - `acu` object
        - `id` integer, required
        - `opal` string
        - `locationRestriction` object, nullable
          - `id` number
          - `allowedDistanceMeters` number
          - `scaleFactor` number
          - `locationMeasurement` object
            - `id` number, required
            - `longitude` number
            - `latitude` number
            - `accuracyMeters` number, nullable
            - `timeZoneId` string, nullable
            - `locationMeasurementSourceType` object
              - …
            - `rawData` object
      - `config` object, nullable
      - `thirdPartyDeviceId` integer
      - `thirdPartyDevice` object
        - `id` integer, required
        - `assignedOrg` object
          - `id` integer, required
          - `name` string
        - `serialNumber` string
        - `isOpSourced` boolean
        - `orderName` string, nullable
        - `createdAt` string, date
        - `updatedAt` string, date
        - `thirdPartyDeviceType` object
          - `id` number, required
          - `manufacturerName` string
          - `hardwareModel` string
          - `description` string
          - `dbModelName` string
          - `createdAt` string, date
          - `updatedAt` string, date
      - `wirelessLockCount` integer
      - `wirelessLockProvider` object
        - `id` number, required
        - `siteIdExt` string, nullable
        - `siteAuthKey` string, nullable
        - `createdAt` string, date
        - `updatedAt` string, date
        - `orgId` number
        - `wirelessLockProviderType` object
          - `id` number, required
          - `name` string
      - `wirelessLockProviderId` integer
    - `wirelessLockProvider` object
      - `id` number, required
      - `siteIdExt` string, nullable
      - `siteAuthKey` string, nullable
      - `createdAt` string, date
      - `updatedAt` string, date
      - `orgId` number
      - `wirelessLockProviderType` object
        - `id` number, required
        - `name` string
    - `entry` object, nullable
      - `id` number, required
      - `name` string
      - `zone` object, nullable
        - `id` number, required
        - `name` string
        - `site` object
          - `id` number, required
          - `name` string
    - `allegionWirelessLock` object, nullable
      - `auditsLastSyncedAt` string, date, nullable
      - `batteryLevel` number, nullable
      - `commStatus` string, nullable
      - `config` object, nullable
        - `battV` object
          - `main` string
          - `li` string
        - `fwVer` object
          - `lock` string
          - `main` string
          - `mainBl` string
          - `credRdr` string
          - `credRdrBl` string
          - `ble` string
          - `wifi` string
          - `macAdr` string
          - `recoveryFwVer` string
        - `lockPrmtrs` object
          - `name` string
          - `type` 'strm' | 'office' | 'apt' | 'prvcy'
          - `relock` integer
          - `lockId` integer
          - `doorProp` integer
          - `ada` integer
          - `firstManIn` 0 | 1
          - `battFail` 'asIs' | 'safe' | 'sec'
          - `blinkIntLed` 'T' | 'F'
          - `rapidBlink` 'T' | 'F'
          - `dstEnable` 0 | 1
          - `dstStart` string
          - `dstEnd` string
          - `rtcTime` string
          - `wifiAlertEn` 'T' | 'F'
          - `wifiAlertSel` string[]
          - `fwUrl` string
          - `fwDwnldTm` string
          - `fwImplTm` string
          - `dpsEn` 'T' | 'F'
          - `bleCredEn` 'T' | 'F'
          - `bleCredRng` 'short' | 'long'
          - `blePerf` 'norm' | 'max'
          - `invCrdAudEn` 'T' | 'F'
          - `wifiDwnldRtyTmIntv` integer
          - `wifiDwnldRtyCnt` integer
          - `auditIDEn` 'T' | 'F'
          - `blkCnstr` 'T' | 'F'
          - `mdl` string
          - `lckMode` string
          - `lckSn` string
          - `mainSn` string
          - `hwVer` string
          - `daysInUse` integer
          - `mfgDt` string
          - `dbDwnldTm` string
          - `fwImpTm` string
          - `nxtDbVerTS` string
          - `hwCfg` string
          - `dbUpdateStatus` integer
          - `wtyAct` string
          - `numCycles` integer
        - `rdrPrmtrs` object
          - `bprEn` 'T' | 'F'
          - `rdrSense` 'norm' | 'high' | 'max'
          - `proxConfHID` 'T' | 'F'
          - `proxConfGECASI` 'T' | 'F'
          - `proxConfGE4001` 'T' | 'F'
          - `proxConfGE4002` 'T' | 'F'
          - `proxConfAWID` 'T' | 'F'
          - `uid14443` 'T' | 'F'
          - `mi14443` 'T' | 'F'
          - `mip14443` 'T' | 'F'
          - `noc14443` 'T' | 'F'
          - `uid15693` 'T' | 'F'
          - `iClsUID40b` 'T' | 'F'
          - `iClsFrmt` 'disbld' | '64bCSN'
          - `daysInUse` integer
          - `sn` string
          - `hwVer` string
          - `mfgDt` string
          - `configCrdPrsntd` 'T' | 'F'
          - `customKeyPrsntd` 'T' | 'F'
        - `dvcProfile` object
          - `baseType` string
          - `ext` object[]
            - `key` string
            - `value` 1 | 0
      - `doorFileLastSyncedAt` string, date, nullable
      - `id` number, required
      - `idExt` string, nullable
      - `linkId` string, nullable
      - `noTourLockId` number, nullable
      - `status` object, nullable
        - `lockStatus` object
          - `currentLockState` string
        - `sensorStatus` object
          - `locked` 'T' | 'F'
          - `auxPosition` 'T' | 'F'
          - `alarmPosition` 'T' | 'F'
          - `lockClutched` 'T' | 'F'
          - `primaryBatteryStatus` string
          - `rtcBatteryStatus` string
          - `rtccStatus` string
          - `doorOpen` 'T' | 'F'
          - `ipbActive` 'T' | 'F'
          - `rexActive` 'T' | 'F'
          - `renActive` 'T' | 'F'
          - `relActive` 'T' | 'F'
          - `deadBoltExtended` 'T' | 'F'
          - `keyOverrideActive` 'T' | 'F'
          - `fdrActive` 'T' | 'F'
          - `tamperOpen` 'T' | 'F'
          - `magTamperDetected` 'T' | 'F'
          - `rdrTamperDetected` 'T' | 'F'
          - `ttl1Active` 'T' | 'F'
          - `ttl2Active` 'T' | 'F'
          - `bprActive` 'T' | 'F'
          - `ledActive` 'T' | 'F'
    - `avigilonWirelessLock` object, nullable
      - `id` number, required
      - `formFactor` string, required
      - `keypadTimeout` integer, nullable
      - `keypadBrightness` integer, nullable
      - `timeOffset` integer, nullable
      - `dstEnabled` boolean, required
      - `networkConfig` object, nullable
      - `firmwareVersions` object, nullable
      - `serialNumber` string, required
    - `assaAbloyWirelessLock` object, nullable
      - `id` number, required
      - `deviceGroupId` string, nullable
      - `wirelessLockId` integer, required
  - `meta` object
    - `accessToken` object, nullable
      - `scopeUpdatedAt` string, date
    - `siteSpecificAccess` object, nullable
      - `isSiteSpecific` boolean
      - `siteIds` integer[], nullable
      - `siteIdsByScope` object, nullable
        - `string` integer[], nullable

---

[API](https://skmtc.net/openpath/apis/openpath-api-documentation.md) · [All operations](https://skmtc.net/openpath/apis/openpath-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/openpath/openpath-api-documentation/versions/d8a888c114fa/schema)