Get all created passcodes of a lock

https://api.sciener.com/v3/lock/listKeyboardPwd

List all passcodes of a lock, including random passcodes and custom passcodes.

1 Request example


xxxxxxxxxx
curl --location -g --request GET 'https://api.sciener.com/v3/lock/listKeyboardPwd?clientId=fd2ff35ee3d8424c8665c07b7b9a7f45&accessToken=780f7671b6e6be3010d9787f19207aca&lockId=1719&pageNo=1&pageSize=20&date=1625025703000'

2 Request parameters

Name	Type	Required	Description
clientId	String	Y	client_id from Create application
accessToken	String	Y	Access token，refer to: Get access token
lockId	Int	Y	Lock ID, generated by Lock init
searchStr	String	N	Search keywords, fuzzy search by passcode name or precise match by passcode
pageNo	Int	Y	Page no, start from 1
pageSize	Int	Y	Items per page, max 200
orderBy	Int	Y	Sort by: 0-by name, 1-reverse order by time, 2-reverse order by name
date	Long	Y	Current time (timestamp in millisecond)

3 Response and example

Parameter	Type	Description
list	JSONArray	list of records
pageNo	Int	Page no, start from 1
pageSize	Int	Items per page, max 200
pages	Int	Total number of pages
total	Int	Total number of records

The objects in the list

Parameter	Type	Description
keyboardPwdId	Int	Passcode ID
lockId	Int	Lock ID, generated by Lock init
keyboardPwd	String	Passcode
keyboardPwdName	String	Passcode name
keyboardPwdType	Int	Passcode type
startDate	Long	The time when it becomes valid (timestamp in millisecond)
endDate	Long	The time when it is expired (timestamp in millisecond)
sendDate	Long	Send time (timestamp in millisecond)
isCustom	Int	Is custom or not: 1-yes, 0-no
senderUsername	String	The sender's username


xxxxxxxxxx
{
    "list": [
        {
            "keyboardPwdId": 3234293,
            "lockId": 532323,
            "keyboardPwd": "034234",
            "keyboardPwdName":"Passcode for Jack",
            "keyboardPwdType": "3",
            "startDate": 1528878944000,
            "endDate": 1628878944000,
            "sendDate": 1528878944000,
            "senderUsername": "alexa@google.com"
        }
    ],
    "pageNo":1,
    "pageSize":20,
    "pages":1,
    "total":1
}