API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Audit Logs

Get Audit Log

GET/v1/audit_logs/{audit_log_id}

List Audit Logs

GET/v1/audit_logs

ModelsExpand Collapse

AuditLog object { id, action, actor, 7 more }

Audit log entry.

id: string

Unique identifier for the audit log entry.

action: string

The action that was performed.

actor: AuditLogActor { id, name, type }

The entity that performed the action.

id: string

Unique identifier for the actor.

name: string

Display name of the actor.

type: AuditLogType

Type of actor.

One of the following:

"user"

"api_key"

client_ip: string

Client IP address.

created_at: string

When the action occurred.

formatdate-time

method: string

HTTP method of the request.

path: string

Request path.

status_code: number

HTTP status code of the response.

user_agent: string

User agent string.

target: optional AuditLogTarget { id, type }

The target resource of the action.

id: string

Unique identifier for the target resource.

type: string

Type of the target resource.

AuditLogActor object { id, name, type }

The entity that performed the action.

id: string

Unique identifier for the actor.

name: string

Display name of the actor.

type: AuditLogType

Type of actor.

One of the following:

"user"

"api_key"

AuditLogList object { items, pagination }

items: array of AuditLog { id, action, actor, 7 more }

id: string

Unique identifier for the audit log entry.

action: string

The action that was performed.

actor: AuditLogActor { id, name, type }

The entity that performed the action.

id: string

Unique identifier for the actor.

name: string

Display name of the actor.

type: AuditLogType

Type of actor.

One of the following:

"user"

"api_key"

client_ip: string

Client IP address.

created_at: string

When the action occurred.

formatdate-time

method: string

HTTP method of the request.

path: string

Request path.

status_code: number

HTTP status code of the response.

user_agent: string

User agent string.

target: optional AuditLogTarget { id, type }

The target resource of the action.

id: string

Unique identifier for the target resource.

type: string

Type of the target resource.

pagination: Pagination { next_cursor, previous_cursor, total_count }

Pagination response details.

next_cursor: string

previous_cursor: string

total_count: number

minimum0

AuditLogTarget object { id, type }

The target resource of the action.

id: string

Unique identifier for the target resource.

type: string

Type of the target resource.

AuditLogType = "user" or "api_key"

Type of actor.

One of the following:

"user"

"api_key"