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.

Available in MCP

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

auditEventIdstring · uuidRequired

Unique identifier of the audit event.

Responses

200

The audit event.

application/json

objectstring · enumRequiredPossible values:

idstring · uuidRequired

Unique identifier of the audit event.

occurredAtstring · date-timeRequired

actionstringRequired

Stable action name describing the recorded change.

sourcestring · enumRequired

Entry point that initiated the change.

Possible values:

executionIdstringOptional

Identifier of the operation that recorded the event.

correlationIdstringOptional

Identifier shared by events produced by the same user action.

causedByEventIdstring · uuidOptional

Audit event that caused this later system effect.

schemaVersioninteger · min: 1Required

Version of the action payload schema.

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not Found

application/json

get/orgs/{organizationId}/audit-events/{auditEventId}

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"
  },
  "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"
  }
}