Open Platform
Skip to content

Get one ekey ​

https://euapi.ttlock.com/v3/key/get

If a user have an ekey of the lock, request this API to get the ekey.

1 Request example ​

javascript
curl --location -g --request GET 'https://euapi.ttlock.com/v3/key/get?clientId=fd2ff35ee3d8424c8665c07b7b9a7f45&accessToken=780f7671b6e6be3010d9787f19207aca&lockId=1719&date=1625025703000'

2 Request parameters ​

NameTypeRequiredDescription
clientIdStringYclient_id from Create application
accessTokenStringYAccess token,refer to: Get access token
lockIdIntYLock ID, generated by Lock init
dateLongYCurrent time (timestamp in millisecond)

3 Response and example ​

ParameterTypeDescription
keyIdIntEkey ID
lockDataStringLock data, used to operate lock
lockIdIntLock ID
userTypeStringEkey type:110301-admin ekey, 110302-common user ekey
keyStatusStringRefer to: Ekey status
lockNameStringLock name
lockAliasStringLock alias
lockMacStringLock MAC
noKeyPwdStringSuper passcode, which only belongs to the admin ekey, can be entered on the keypad to unlock
electricQuantityIntLock battery
startDateLongThe time when it becomes valid (timestamp in millisecond)
endDateLongThe time when it is expired (timestamp in millisecond)
remarksStringComment
keyRightIntIs ekey authorized: 0-NO, 1-yes
featureValueStringcharacteristic value. it is used to indicate what kinds of feature do a lock support.
remoteEnableIntIs remote unlock enabled: 1-yes,2-no
passageModeIntPassage mode:1-enable、2-disable
timezoneRawOffsetLongThe offset between your time zone and UTC, in millisecond
groupIdIntGroup ID
groupNameStringGroup name
{
    "keyId": 3234293,
    "lockData": "xxxxxxx",
    "lockId": 532323,
    "userType": "110302",
    "keyStatus": "110401",
    "lockName": "M102_ed8e8d",
    "lockAlias": "Front door lock",
    "lockMac": "68:9E:19:00:67:81",
    "noKeyPwd": "345634",
    "electricQuantity": 85,
    "startDate": 1528878944000,
    "endDate": 1628878944000,
    "remarks": "Wish you a happy rent.",
    "keyRight": 1,
    "featureValue": "6C4CD1F3",
    "remoteEnable": 0,
    "passageMode": 1,
    "groupId": 7619,
    "groupName": "The 4th floor"
}
CopyRight © 2012-2026 TTLock.All Rights Reserved