Skip to content

SmartlockLog

Get a list of smartlock logs for all smartlocks in the account.

GET /smartlock/log

Parameters:

Name Type Description Default
params dict

Query filters such as: - accountUserId (int): Filter by account user ID. - fromDate (str): Start date (RFC3339). - toDate (str): End date (RFC3339). - action (int): Filter by action code. - id (str): Return logs older than this ID. - limit (int): Max number of logs (default: 20, max: 50).

 None

Returns:

Type Description
List[Dict[str, Any]]

list[dict]: List of smartlock log entries.
Source code in nukiwebapi/smartlock_log.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
def list_logs(self, params: Optional[Dict[str, Any]] = None) -> List[Dict[str, Any]]:
    """
    Get a list of smartlock logs for all smartlocks in the account.

    GET /smartlock/log

    Args:
        params (dict, optional): Query filters such as:
            - accountUserId (int): Filter by account user ID.
            - fromDate (str): Start date (RFC3339).
            - toDate (str): End date (RFC3339).
            - action (int): Filter by action code.
            - id (str): Return logs older than this ID.
            - limit (int): Max number of logs (default: 20, max: 50).

    Returns:
        list[dict]: List of smartlock log entries.
    """
    return self.client._request("GET", "/smartlock/log", params=params)

Get a list of smartlock logs for a specific smartlock.

GET /smartlock/{smartlockId}/log

Parameters:

Name Type Description Default
smartlock_id int

The smartlock ID.

 required
params dict

Query filters such as: - authId (str): Filter by authorization ID. - accountUserId (int): Filter by account user ID. - fromDate (str): Start date (RFC3339). - toDate (str): End date (RFC3339). - action (int): Filter by action code. - id (str): Return logs older than this ID. - limit (int): Max number of logs (default: 20, max: 50).

 None

Returns:

Type Description
List[Dict[str, Any]]

list[dict]: List of smartlock log entries.
Source code in nukiwebapi/smartlock_log.py 
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
def list_logs_for_smartlock(
    self, smartlock_id: int, params: Optional[Dict[str, Any]] = None
) -> List[Dict[str, Any]]:
    """
    Get a list of smartlock logs for a specific smartlock.

    GET /smartlock/{smartlockId}/log

    Args:
        smartlock_id (int): The smartlock ID.
        params (dict, optional): Query filters such as:
            - authId (str): Filter by authorization ID.
            - accountUserId (int): Filter by account user ID.
            - fromDate (str): Start date (RFC3339).
            - toDate (str): End date (RFC3339).
            - action (int): Filter by action code.
            - id (str): Return logs older than this ID.
            - limit (int): Max number of logs (default: 20, max: 50).

    Returns:
        list[dict]: List of smartlock log entries.
    """
    return self.client._request(
        "GET", f"/smartlock/{smartlock_id}/log", params=params
    )