Get an organization audit event
Returns the full allowlisted payload for one recorded organization change. Access is restricted to organization administrators and GitBook staff. The organization must be activated and on an active Enterprise plan, except for GitBook's own organization. Events older than 365 days are unavailable and return 404.
A unique entity identifier
^[a-zA-Z0-9_-]+$Unique identifier of the audit event.
The audit event.
Unique identifier of the audit event.
Stable action name describing the recorded change.
Entry point that initiated the change.
Identifier of the operation that recorded the event.
Identifier shared by events produced by the same user action.
Audit event that caused this later system effect.
Version of the action payload schema.
Unauthorized
Forbidden
Not Found
GET /v1/orgs/{organizationId}/audit-events/{auditEventId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"object": "audit-event",
"id": "123e4567-e89b-12d3-a456-426614174000",
"occurredAt": "2026-01-01T00:00:00.000Z",
"action": "text",
"actor": {
"type": "user",
"id": "text",
"label": "text",
"impersonator": {
"id": "text",
"label": "text"
}
},
"source": "ui",
"target": {
"type": "text",
"id": "text",
"label": "text"
},
"urls": {
"location": "https://example.com"
},
"executionId": "text",
"correlationId": "text",
"causedByEventId": "123e4567-e89b-12d3-a456-426614174000",
"schemaVersion": 1,
"payload": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}Last updated
Was this helpful?