List documents and document groups
list_documentsRetrieve a unified list of documents and document groups with filters by status, folder, expiration, and sorting options.
Instructions
Get simplified list of documents and document groups with basic information. Returns both documents and document groups in a unified format. Use this tool to fetch lists of documents by status, e.g. documents waiting for your signature (waiting-for-me) or expired documents (expired_filter=expired).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of items to return (1-100, default 50) | |
| order | No | Order of sorting (optional, can be used only with sortby). Available values: asc, desc. | |
| filter | No | Filter by document group status (optional). Available values: signed, pending, waiting-for-me, waiting-for-others, unsent. | |
| offset | No | Number of items to skip for pagination (default 0) | |
| sortby | No | Sort by created date, updated date, or document name (optional). Available values: updated, created, document-name. | |
| folder_id | No | Filter by folder ID (optional) | |
| expired_filter | No | Filter by invite expiredness (optional, default: all). Available values: all, expired, not-expired. | all |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of items in this page | |
| offset | No | Number of items skipped | |
| has_more | No | Whether more items exist beyond this page | |
| document_groups | Yes | ||
| document_group_total_count | Yes | Total number of document groups across all pages |