Open Platform
Skip to content

Get all IC cards of a lock ​

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

List all cards added to the lock.

1 Request example ​

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

2 Request parameters ​

NameTypeRequiredDescription
clientIdStringYclient_id from Create application
accessTokenStringYAccess token,refer to: Get access token
lockIdIntYLock ID, generated by Lock init
searchStrStringNSearch keywords, fuzzy search by IC card name
pageNoIntYPage no, start from 1
pageSizeIntYItems per page,max 200
orderByIntYSort by: 0-by name, 1-reverse order by time, 2-reverse order by name
dateLongYCurrent time (timestamp in millisecond)

3 Response and example ​

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

The objects in the list

ParameterTypeDescription
cardIdIntCard ID
lockIdIntLock ID
cardNumberStringCard number
cardNameStringCard name
startDateLongThe time when it becomes valid (timestamp in millisecond)
endDateLongThe time when it is expired (timestamp in millisecond)
createDateLongCreate time (timestamp in millisecond)
senderUsernameStringThe sender's username
cardTypeIntCard type:1-noraml card、4-cyclic
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.
{
    "list": [
        {
            "cardId": 124242,
            "lockId": 163377,
            "cardNumber": "1723612378",
            "cardName":"Card for mom",
            "cardType": 4,
            "startDate": 1625025703000,
            "endDate": 1645025703000,
            "createDate": 1625025703000,
            "senderUsername": "alexa@google.com"
        }
    ],
    "pageNo":1,
    "pageSize":20,
    "pages":1,
    "total":1
}
CopyRight © 2012-2026 TTLock.All Rights Reserved