Skip to main content
GET
/
api
/
v1
/
audit-logs
List audit logs
import requests

url = "https://api.example.com/api/v1/audit-logs"

response = requests.get(url)

print(response.text)
{
  "result": {
    "items": [
      {
        "id": 123,
        "principal_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "principal_type": "<string>",
        "wallet_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "resource_type": "<string>",
        "resource_id": "<string>",
        "action": "unknown",
        "result": "allowed",
        "authz_details": {},
        "request": {},
        "error": "<string>",
        "created_at": "2023-11-07T05:31:56Z"
      }
    ],
    "next_cursor": "<string>"
  },
  "success": true,
  "suggestion": "",
  "message": "",
  "meta": {
    "total": 123,
    "offset": 123,
    "limit": 123,
    "has_more": true,
    "after": "<string>",
    "before": "<string>"
  }
}

Headers

​
X-API-Key
string | null

Query Parameters

​
wallet_id
string<uuid> | null

Filter audit logs by wallet ID. The wallet ID can be retrieved by calling the List all wallets operation.

​
principal_id
string<uuid> | null

Filter audit logs by the principal that performed the action. The principal ID can be retrieved by calling the List all principals operation.

​
action
string | null

Filter audit logs by action name (for example, transfer.initiate, delegation.create).

Required string length: 1 - 128
​
result
enum<string> | null

Filter audit logs by result. Possible values: allowed, denied, pending, error. If omitted, all results are returned.

Available options:
allowed,
denied,
pending,
error
​
start_time
string<date-time> | null

Filter audit logs created at or after this timestamp (ISO 8601 format).

​
end_time
string<date-time> | null

Filter audit logs created before this timestamp (ISO 8601 format).

​
after
string | null

A cursor for forward pagination. Pass the after value from meta in a previous response to retrieve the next page.

​
before
string | null

A cursor for backward pagination. Pass the before value from meta in a previous response to retrieve the preceding page.

​
cursor
string | null
deprecated

Deprecated. Use after instead (same semantics).

​
limit
integer
default:50

The maximum number of items to return. Range: [1, 200].

Required range: 1 <= x <= 200

Response

Successful Response

​
result
AuditLogPage · object
required

Cursor-paginated audit result set (legacy shape; also see response meta).

​
success
boolean
default:true
​
suggestion
string
default:""
​
message
string
default:""
​
meta
PaginationMeta · object

Pagination metadata for list responses.

Supports both legacy offset-based and cursor-based pagination. Cursor fields (has_more, after, before) are populated for cursor-paginated endpoints. Legacy fields (offset, limit) are populated when the caller uses the deprecated offset parameter.