Skip to main content
GET
/
v1
/
audit
/
events
List Audit Events
curl --request GET \
  --url https://api.example.com/v1/audit/events
import requests

url = "https://api.example.com/v1/audit/events"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.example.com/v1/audit/events', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
{
  "events": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organization_id": "<string>",
      "event_type": "<string>",
      "resource_type": "<string>",
      "resource_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "actor_id": "<string>",
      "ip_address": "<string>",
      "user_agent": "<string>",
      "detail": {}
    }
  ],
  "total": 123
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}

Headers

authorization
string | null

Query Parameters

event_type
string | null
resource_type
string | null
resource_id
string | null
actor_id
string | null
since
string<date-time> | null
until
string<date-time> | null
limit
integer
default:50
Required range: x <= 200
offset
integer
default:0

Response

Successful Response

events
AuditEventResponse · object[]
required
total
integer
required