Outline Wiki icon

Outline Wiki

Interact with the Outline Wiki API — documents, collections, comments, attachments, users, shares

Actions31

Share → List

AI-generated

Summary

List existing public share links with optional pagination filters to control the number of results and offset.

Inputs

  • Filters — Optional filters to limit the number of share links returned and offset them for pagination. Supports 'Limit' (maximum number of results, default 25) and 'Offset' (pagination offset, default 0).

Output shape

a list of share link records as JSON objects

The operation returns a JSON array of share objects corresponding to the configured pagination filters. Results can be paged through limit and offset parameters.

Examples

Example 1: List first 25 share links

No filters or default limit (25) and offset (0) used, returns up to 25 share links from the start.

Example 2: List share links with offset

Set 'Limit' to 10 and 'Offset' to 20 to retrieve share links 21-30.

Links

Discussion