Actions31
- Agent Actions
- Attachment Actions
- Comment Actions
- Config Actions
- Dartboard Actions
- Doc Actions
- Folder Actions
- Help Center Article Actions
- Skill Actions
- Task Actions
- View Actions
Doc → List Docs
AI-generatedSummary
List Docs retrieves a filtered, paginated collection of documents.
Inputs
- limit — Max number of results to return
- offset — The initial index from which to return the results
- additionalFields — Filter parameters for the doc list (e.g., editor, folder, folder_id, ids, in_trash, no_defaults, order, s, text, title)
- requestOptions — Various request settings such as proxy, timeout, SSL verification, and batching configuration
Output shape
A paginated array of doc objects
Pagination is controlled by limit/offset; optional filters can restrict results by folder, title, IDs, etc.; each doc includes fields like id, title, folder, created_at, updated_at, and other metadata. The response may include additional metadata depending on the API version.
Examples
Example 1: List the first 20 docs with default filters
limit=20, offset=0, additionalFields={}
Example 2: Search docs by title and limit to 50 results
title=Project, limit=50, additionalFields={}
Example 3: Paginate through docs with batching enabled
limit=100, batching.batchSize=50, batching.batchInterval=1000, additionalFields={}