outline icon

outline

Interact with outline API

Actions107

Events → Events List

AI-generated

Summary

Retrieve events from the Outline API, filtered by optional parameters such as name, actor ID, document ID, or collection ID.

Inputs

  • name — Filter to a specific event, e.g. collections.create. Event names are in the format objects.verb
  • actorId — Filter to events performed by the selected user
  • documentId — Filter to events performed in the selected document
  • collectionId — Filter to events performed in the selected collection
  • auditLog — Whether to return detailed events suitable for an audit log. Without this flag less detailed event types will be returned.
  • requestOptions — Batching and other request options.

Output shape

main

Returns events from the Outline API based on the applied filters and request configuration.

Examples

Example 1: List recent events

Leave all filter parameters empty; set auditLog to true for full detail.

Links

Discussion