List organization audit events
Lists recorded changes for an activated organization. Access is restricted to organization administrators and GitBook staff, and results are ordered by occurrence time, newest first. An active Enterprise plan is required except for GitBook's own organization. Only events from the latest 365 days are available, including in counts and facets.
A unique entity identifier
^[a-zA-Z0-9_-]+$Identifier of the page results to fetch.
Number of events to return, up to 100.
20Include events occurring at or after this time, within the latest 365 days.
Include events occurring at or before this time.
Filter by an exact audit action name.
Filter by an exact stable actor identifier.
Filter by an exact stable target identifier.
Include matching counts for action and actor options, excluding the option's own filter.
Include any of these action names. Combined with other filters using AND.
Include any of these stable actor identifiers, including system actors. Combined with other filters using AND.
Paginated audit events.
Total count of objects in the list
Bad Request
Unauthorized
Forbidden
Not Found
GET /v1/orgs/{organizationId}/audit-events HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"next": {
"page": "text"
},
"count": 1,
"facets": {
"actions": {
"ANY_ADDITIONAL_PROPERTY": 1
},
"actors": {
"ANY_ADDITIONAL_PROPERTY": 1
}
},
"items": [
{
"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"
}
}
]
}Last updated
Was this helpful?