API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Audit Logs

Get Audit Log

client.auditLogs.get(stringauditLogID, RequestOptionsoptions?): AuditLog { id, action, actor, 7 more }

GET/v1/audit_logs/{audit_log_id}

List Audit Logs

client.auditLogs.list(AuditLogListParams { action, actor_id, actor_type, 12 more } query?, RequestOptionsoptions?): Cursor<AuditLog { id, action, actor, 7 more } >

GET/v1/audit_logs

ModelsExpand Collapse

AuditLog { 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 | null

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?: AuditLogTarget { id, type } | null

The target resource of the action.

id: string

Unique identifier for the target resource.

type: string

Type of the target resource.

AuditLogActor { id, name, type }

The entity that performed the action.

id: string

Unique identifier for the actor.

name: string | null

Display name of the actor.

type: AuditLogType

Type of actor.

One of the following:

"user"

"api_key"

AuditLogList { items, pagination }

items: Array<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 | null

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?: AuditLogTarget { id, type } | null

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 | null

previous_cursor: string | null

total_count: number

minimum0

AuditLogTarget { 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" | "api_key"

Type of actor.

One of the following:

"user"

"api_key"