List
AI-generatedSummary
Retrieve a list of documents from an organization in DocRouter.ai, optionally filtering by tag IDs, searching document names, or matching metadata key-value pairs.
Inputs
- Limit — Maximum number of documents to return (1 to 100, default 50).
- Skip — Number of documents to skip for pagination (minimum 0, default 0).
- Filter by Tag IDs — Comma-separated tag IDs to filter the documents returned.
- Name Search — Search term to filter documents by name.
- Metadata Search — Comma-separated key=value pairs to filter documents by metadata (e.g., "author=John,type=invoice").
Output shape
a single JSON object containing the list of documents matching the criteria
The returned JSON includes document data as provided by the DocRouter.ai API. Pagination is controlled via 'Limit' and 'Skip' parameters. Errors throw or are returned if 'Continue On Fail' is active.
Examples
Example 1: List up to 20 documents skipping the first 10, filtered by tags 'tag1' and 'tag2'
Set Limit to 20, Skip to 10, and Filter by Tag IDs to 'tag1,tag2'.
Example 2: Search documents by name containing 'report' and metadata author=Alice
Set Name Search to 'report' and Metadata Search to 'author=Alice'.