[comment]: # ({668456d1-668456d1})
# auditlog.get

[comment]: # ({/668456d1-668456d1})

[comment]: # ({002826bb-002826bb})
### Description

`integer/array auditlog.get(object parameters)`

The method allows to retrieve audit log records according to the given
parameters.

::: noteclassic
This method is only available to *Super admin* user type.
Permissions to call the method can be revoked in user role settings. See
[User
roles](/manual/web_interface/frontend_sections/administration/user_roles)
for more information.
:::

[comment]: # ({/002826bb-002826bb})

[comment]: # ({52f89494-c9891e0d})
### Parameters

`(object)` Parameters defining the desired output.

The method supports the following parameters.

|Parameter|[Type](/manual/api/reference_commentary#data_types)|Description|
|--|--|------|
|auditids|string/array|Return only audit log with the given IDs.|
|userids|string/array|Return only audit log that were created by the given users.|
|time\_from|timestamp|Returns only audit log entries that have been created after or at the given time.|
|time\_till|timestamp|Returns only audit log entries that have been created before or at the given time.|
|sortfield|string/array|Sort the result by the given properties.<br><br>Possible values are: `auditid`, `userid`, `clock`.|
|filter|object|Return only results that exactly match the given filter.<br><br>Accepts an array, where the keys are property names, and the values are either a single value or an array of values to match against.<br><br>Additionally supports filtering by details property fields: `table_name`, `field_name`.|
|search|object|Case insensitive sub-string search in content of fields: `username`, `ip`, `resourcename`, `details`.|
|countOutput|boolean|These parameters being common for all `get` methods are described in the [reference commentary](/manual/api/reference_commentary#common_get_method_parameters).|
|excludeSearch|boolean|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/52f89494-c9891e0d})

[comment]: # ({7223bab1-7223bab1})
### Return values

`(integer/array)` Returns either:

-   an array of objects;
-   the count of retrieved objects, if the `countOutput` parameter has
    been used.

[comment]: # ({/7223bab1-7223bab1})

[comment]: # ({b41637d2-b41637d2})
### Examples

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({66670b26-66670b26})
#### Retrieve audit log

Retrieve two latest audit log records.

Request:

``` {.java}
{
    "jsonrpc": "2.0",
    "method": "auditlog.get",
    "params": {
        "output": "extend",
        "sortfield": "clock",
        "sortorder": "DESC",
        "limit": 2
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}
```

Response:

``` {.java}
{
    "jsonrpc": "2.0",
    "result": [
        {
            "auditid": "cksstgfam0001yhdcc41y20q2",
            "userid": "1",
            "username": "Admin",
            "clock": "1629975715",
            "ip": "127.0.0.1",
            "action": "1",
            "resourcetype": "0",
            "resourceid": "0",
            "resourcename": "Jim",
            "recordsetid": "cksstgfal0000yhdcso67ondl",
            "details": "{\"user.name\":[\"update\",\"Jim\",\"\"],\"user.medias[37]\":[\"add\"],\"user.medias[37].\":[\"add\"],\"user.medias[37].mediatypeid\":[\"add\",\"1\"],\"user.medias[37].sendto\":[\"add\",\"support123@company.com\"]}"
            
        },
        {
            "auditid": "ckssofl0p0001yhdcqxclsg8r",
            "userid": "1",
            "username": "Admin",
            "clock": "1629967278",
            "ip": "127.0.0.1",
            "action": "0",
            "resourcetype": "0",
            "resourceid": "20",
            "resourcename": "John",
            "recordsetid": "ckssofl0p0000yhdcpxyo1jgo",
            "details": "{\"user.username\":[\"add\",\"John\"], \"user.userid:\":[\"add\",\"20\"],\"user.usrgrps[28]\":[\"add\"],\"user.usrgrps[28].usrgrpid\":[\"add\", \"7\"]}"
        }
    ],
    "id": 1
}
```

[comment]: # ({/66670b26-66670b26})

[comment]: # ({e2b9a859-e2b9a859})
### See also

-   [Audit log object](/manual/api/reference/auditlog/object)

[comment]: # ({/e2b9a859-e2b9a859})

[comment]: # ({11b31975-11b31975})
### Source

CAuditLog::get() in *ui/include/classes/api/services/CAuditLog.php*.

[comment]: # ({/11b31975-11b31975})