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.

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_-]+$
Query parameters
pagestringOptional

Identifier of the page results to fetch.

limitinteger · min: 1 · max: 100Optional

Number of events to return, up to 100.

Default: 20
fromstring · date-timeOptional

Include events occurring at or after this time, within the latest 365 days.

tostring · date-timeOptional

Include events occurring at or before this time.

actionstringOptional

Filter by an exact audit action name.

actorstringOptional

Filter by an exact stable actor identifier.

targetstringOptional

Filter by an exact stable target identifier.

includeFacetsbooleanOptional

Include matching counts for action and actor options, excluding the option's own filter.

actionsstring[] · max: 100Optional

Include any of these action names. Combined with other filters using AND.

actorsstring[] · max: 100Optional

Include any of these stable actor identifiers, including system actors. Combined with other filters using AND.

Responses
200

Paginated audit events.

application/json
countnumberOptional

Total count of objects in the list

get/orgs/{organizationId}/audit-events
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?

Powered by GitBook