Open Platform
Skip to content

Get the lock list of an account ​

https://cnapi.sciener.com/v3/lock/list

List locks added by you,no matter it is added by Sciener APP or added by APP SDK and initialized by cloud API: Lock init

  • If your locks were added by Sciener APP,request this API with the access token get with the username and password of the user account you login Sciener APP.

  • If your locks were initialized by cloud API:Lock init, request with the same access token when init the lock.

This API will only return locks which you are top administrator. Ekeys others shared to you can be queried by cloud API: ekey list.

If integrated with TTHotel, this API can also retrieve lists of power savers or lift controls. Simply add the parameter 'type': type = 1 for lock list, type = 2 for lift control list, and type = 3 for power saver list.

1 Request example ​

POST, ContentType:application/x-www-form-urlencoded

javascript
curl --location -g --request GET 'https://cnapi.sciener.com/v3/lock/list?clientId=fd2ff35ee3d8424c8665c07b7b9a7f45&accessToken=780f7671b6e6be3010d9787f19207aca&pageNo=1&pageSize=20&date=1625025703000&groupId=1719'

2 Request parameters ​

NameTypeRequiredDescription
clientIdStringYclient_id from Create application
accessTokenStringYAccess token,refer to: Get access token
lockAliasStringNSearch by lock alias, fuzzy matching
groupIdIntNGroup ID,search by group, refer to: Add group for detail
pageNoIntYPage no, start from 1
pageSizeIntYItems per page, default 20, max 1000
dateLongYCurrent time (timestamp in millisecond)

3 Response and example ​

ParameterTypeDescription
listJSONArraylist of records
pageNoIntPage no, start from 1
pageSizeIntItems per page, default 20, max 10000
pagesIntTotal number of pages
totalIntTotal number of records

The objects in the list

ParameterTypeDescription
lockIdIntLock ID, generated by Lock init
lockNameStringLock name
lockAliasStringLock alias
lockMacStringLock MAC
electricQuantityIntLock battery
featureValueStringcharacteristic value. it is used to indicate what kinds of feature do a lock support.
hasGatewayIntIs the lock binded to gateway:1-yes, 0-no
lockDataStringLock data, used to operate the lock
groupIdIntGroup id
groupNameStringGroup name
dateLongLock init time (timestamp in millisecond)
{
    "list": [
        {
            "lockId": 532323,
            "lockName":"YS1003_c18c9c",
            "lockAlias":"Front door lock",
            "lockMac": "C5:40:E0:9C:8C:C1",
            "electricQuantity": 55,
            "featureValue":"3F0421C4F5F3",
            "hasGateway": 1,
            "lockData": "xxxxxxxxxxxxx",
            "groupId": 456,
            "groupName": "The 4th floor",
            "date": 1528878944000}
    ],
    "pageNo":1,
    "pageSize":20,
    "pages":1,
    "total":1
}
CopyRight © 2012-2026 Sciener.All Rights Reserved