Skip to content
Start in Cloud

List instance audit log

GET
/api/admin/system/audit
curl --request GET \
--url https://hitkeep.com/api/admin/system/audit \
--cookie hk_token=<hk_token>

Lists instance-level audit entries for system maintenance and admin operations. Malformed actor, date, limit, and offset filters return 400.

action
string

Optional exact action filter.

target_type
string

Optional target type filter.

outcome
string

Optional outcome filter, for example success or failure.

actor_id
string format: uuid

Optional actor user ID filter.

from
string format: date-time

Optional RFC3339 lower time bound.

to
string format: date-time

Optional RFC3339 upper time bound.

query
string

Optional free-text search over action, actor, target, outcome, IP, request ID, and details.

limit
integer
>= 1 <= 200

Maximum number of rows to return.

offset
integer

Zero-based row offset.

Instance audit entries

Media type application/json
object
entries
Array<object>
object
action
string
actor_email_snapshot
string
actor_id
string format: uuid
actor_role_snapshot
string
created_at
string format: date-time
details
string
id
string format: uuid
ip_address
string
ip_country_code
string
outcome
string
request_id
string
target_id
string
target_label
string
target_type
string
target_user_id
string format: uuid
team_id
string format: uuid
user_agent
string
has_more
boolean
limit
integer
offset
integer
total
integer
Example generated
{
"entries": [
{
"action": "example",
"actor_email_snapshot": "example",
"actor_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"actor_role_snapshot": "example",
"created_at": "2026-04-15T12:00:00Z",
"details": "example",
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"ip_address": "example",
"ip_country_code": "example",
"outcome": "example",
"request_id": "example",
"target_id": "example",
"target_label": "example",
"target_type": "example",
"target_user_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"team_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"user_agent": "example"
}
],
"has_more": true,
"limit": 1,
"offset": 1,
"total": 1
}

Invalid audit filter

Media type application/json
object
message
string
Example generated
{
"message": "example"
}