Skip to main content
GET
List audit logs

Authorizations

Authorization
string
header
required

An Admin API key, starting with cas_admin_.

Query Parameters

category
enum<string>

Only return events in this category.

Available options:
authentication,
identity-access,
organization,
agents,
chats,
workflows,
knowledge-base,
integrations,
meetings,
billing,
audit,
cassidy-apps
actorId

Only return events performed by this actor: a user ID, an Admin API key ID, or cassidy for system events.

subjectType
string

Only return events about this kind of resource, such as agent.

subjectId
string

Only return events about the resource with this ID.

targetId
string

Only return events whose target has this ID.

action
string

With subjectType, only return this action, such as created.

operationTypes
enum<string>[]

Only return events of these operation types, as a comma-separated list.

Minimum array length: 1
Available options:
read,
create,
update,
delete,
execute
order
enum<string>

desc (the default) returns the newest events first, and asc the oldest first. Using asc with no to is polling mode, which follows new events as they arrive.

Available options:
asc,
desc
from
string<date-time>

Inclusive start of the range as an ISO 8601 timestamp. Required without cursor.

to
string<date-time>

Exclusive end of the range as an ISO 8601 timestamp. Defaults to now, except with order=asc, where leaving it out uses polling mode. The range can span at most 3 months. Events can take up to 2 minutes to appear.

limit
integer
default:100

Maximum number of records to return.

Required range: 1 <= x <= 1000
cursor
string

The nextCursor from the previous response. It keeps the first request's order, from, and to, so you can leave those out, but any you pass must match. Pass the same filters as the first request.

Response

Successful response

nextCursor
string | null
required

Pass as cursor to get the next page. Null on the last page, except in polling mode, where it is always returned so the next request resumes from it.

hasMore
boolean
required

Whether more events are available now.

auditLogs
object[]
required