Open Platform
Skip to content

Get Palm vein list of a lock ​

https://cnapi.ttlock.com/v3/palmVein/list

1 Request method and example ​

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

json
curl --location -g --request POST 'https://cnapi.ttlock.com/v3/palmVein/list'\
--data-urlencode 'clientId=4773aa036f7f49c68d876bb4be85c80c' \
--data-urlencode 'accessToken=dfd5489d0cee31f0bdfaf59d0d42d71f' \
--data-urlencode 'lockId=3466252' \
--data-urlencode 'pageNo=1' \
--data-urlencode 'pageSize=10' \
--data-urlencode 'date=1625025703000'

2 Request parameters ​

NameTypeRequiredDescription
clientIdStringYclient_id from Create application
accessTokenStringYAccess token,refer to: Get access token
lockIdIntYid of a lock
searchStrStringNSearch string (name fuzzy matching)
pageNoIntYPage no, start from 1
pageSizeIntYItems per page, max 200
dateLongYCurrent time (timestamp in millisecond)

3 Response and example ​

ParameterTypeDescription
idIntid of a palm vein
nameStringname of a palm vein
numberStringnumber of a palm vein
statusStringStatus: 1-normal, 2-invalid, 3-pending
nicknameStringnickname of creator
startDateLongThe time when it becomes valid (timestamp in millisecond)
endDateLongThe time when it is expired (timestamp in millisecond)
typeIntType:1-Normal、4-Recurring
cyclicConfigJsonArrayRecurring time period, the valid time period of each week day must be the same, for example: [{"weekDay":1, "startTime":480,"endTime":1080},{"weekDay":2, "startTime":480,"endTime":1080}] for valid from 8:00 to 18:00 in Monday and Tuesday.
createDateLongCreation time

cyclicConfig:

ParameterTypeDescription
startTimeIntThe time when it becomes valid, in minute, for example 480 for 8:00
endTimeIntThe time when it becomes validit is expired, in minute, for example 1080 for 18:00
weekDayIntWeek day:1-7, 1-Monday, 2-Tuesday...7-Sunday
javascript
{
    "list": [
        {
            "id": 34242,
            "type": 1,
            "number":50432139657219,
            "name": "Test",
            "startDate": 1625025703000,
            "endDate": 1665025703000,
            "status": 1,
            "createDate": 1625025703000,
            "nickname": "landlord2"}
    ],
    "pageNo":1,
    "pageSize":10,
    "pages":1,
    "total":1
}
CopyRight © 2012-2026 TTLock.All Rights Reserved