Skip to main content
GET
/
management
/
audit_logs
TypeScript
const response: Promise<FireblocksResponse<GetAuditLogsResponse>> = fireblocks.auditLogs.getAuditLogs(auditLogsApiGetAuditLogsRequest);
{
  "data": [
    {
      "id": "<string>",
      "timestamp": 123,
      "createdAt": 123,
      "user": "<string>",
      "subject": "<string>",
      "event": "<string>",
      "category": "Administration",
      "tenantId": "<string>",
      "userId": "<string>"
    }
  ],
  "next": "eyJpZCI6IjEyMzQ1NiJ9",
  "cursor": "<string>"
}

Query Parameters

​
startTime
integer

Start of date range as epoch time in milliseconds. Takes precedence over timePeriod when provided. Must be no more than 1 year before the current time.

​
endTime
integer

End of date range as epoch time in milliseconds. Must be after startTime. Defaults to now when omitted.

​
timePeriod
enum<string>

Deprecated. Use startTime/endTime instead. Ignored when startTime is provided. Defaults to DAY when neither timePeriod nor startTime is supplied.

Available options:
DAY,
WEEK
​
category
string[]

Filter by event category. Repeat the parameter for multiple values (OR logic within field).

​
subject
string[]

Filter by event subject. Repeat the parameter for multiple values.

​
event
string[]

Filter by event type. Repeat the parameter for multiple values.

​
user
string[]

Filter by user name. Repeat the parameter for multiple values.

​
userId
string[]

Filter by user ID. Repeat the parameter for multiple values.

​
order
enum<string>
default:DESC

Sort direction. Defaults to DESC.

Available options:
ASC,
DESC
​
pageSize
integer
default:200

Number of results per page. Maximum 500. Defaults to 200.

Required range: 1 <= x <= 500
​
pageCursor
string

Cursor returned from the previous response to fetch the next page.

​
cursor
string

Deprecated. Use pageCursor instead.

Response

Audit log events matching the requested filters and date range

​
data
object[]
​
next
string | null

Cursor to pass as pageCursor in the next request. Null when no further pages exist.

Example:

"eyJpZCI6IjEyMzQ1NiJ9"

​
cursor
string | null
deprecated

Deprecated. Use next instead.