ESescape
Audit

List audit logs

List audit logs of the organization.

get/audit/logs

Request

  • Base URL
    https://public.escape.tech/v3
  • Auth
    API key in header X-ESCAPE-API-KEY

Query parameters

cursorstring

The cursor to start the pagination from. Returned by the previous page response. If not provided, the first page will be returned.

Example:R1BDOlM6NTEwMzk4NTYtNGIyOS00NTlkLTg0ZDYtMWJhYjM0NWMzZjU5
sizeinteger

The number of items to return per page

Example:50
sortType'ACTION' | 'ACTOR' | 'DATE' | 'TARGET' | 'TITLE'

The type to sort by

sortDirection'asc' | 'desc'

The direction to sort by

startTimestring

An ISO 8601 timestamp to filter audit logs after

Example:2025-01-01T00:00:00Z
endTimestring

An ISO 8601 timestamp to filter audit logs before

Example:2025-01-01T00:00:00Z
actionstring

Filter by action type (exact match)

Example:user.confirmed
actorstring

Filter by actor (exact match on the actor ID; use search for emails or partial values)

Example:00000000-0000-0000-0000-000000000000
targetstring

Filter by target (case-insensitive substring match)

Example:scan-123
searchstring

Filter by search term

Example:Scan Started

Response

OK

nextCursorstring nullable required
totalCountinteger

Example response

{
  "totalCount": 20
}

Changes

No recorded changes to this operation across all 1 revision of this API.