auditlogs

List Audit Logs

This endpoint lists all audit logs of user.

get/auditlogs

Request

Response

Audit logs retrieved successfully

log_idstring

Unique identifier for the log entry

customer_idstring

The ID or email of the customer associated with the log

actorstring

The user or system that performed the action

timestampinteger

Unix timestamp of when the action occurred

actioninteger

Numeric ID representing the specific action type

action_stringstring

Human-readable description of the action

sourcestring

The source method or client used to perform the action

entitystring

The primary entity affected by the action

secondary_entitystring

A secondary entity affected, "" or "NA" if not applicable

third_entitystring

A tertiary entity affected, "" or "NA" if not applicable

readable_formatstring

formatted string for display purposes

ipstring ipv4

The IP address from which the request originated

ttlinteger

Time to live (expiration) timestamp for this log entry

reasonstring

The reason for the action, if provided

notesstring

Additional notes regarding the action

Example response

[
  {
    "log_id": "ab9744ed-f51c-4z58-a3cj-e3bs756154du",
    "customer_id": "example@example.com",
    "actor": "example@example.com",
    "timestamp": 1764587058,
    "action": 13,
    "action_string": "Delete Team",
    "source": "API_KEY - system_tests",
    "entity": "test_team",
    "secondary_entity": "NA",
    "ip": "1.2.3.4",
    "ttl": 1780311858
  }
]

Changes

No recorded changes to this operation across all 3 revisions of this API.