list_envelopes
Retrieve digital signature envelopes with status filtering to monitor and manage document signing workflows.
Instructions
List envelopes with optional status filter. Returns envelope IDs, names, and statuses.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | No | Filter by status | |
| page | No | Page number (default 1) | |
| itemsPerPage | No | Items per page (default 10) |
Implementation Reference
- src/api.js:70-77 (handler)Implementation of the function that performs the API call to list envelopes.
export function listEnvelopes(creds, params = {}) { const query = new URLSearchParams(); if (params.status) query.set('status', params.status); if (params.page) query.set('page', params.page); if (params.itemsPerPage) query.set('itemsPerPage', params.itemsPerPage); const qs = query.toString(); return apiCall('GET', `/api/envelopes${qs ? '?' + qs : ''}`, creds); } - src/index.js:44-60 (registration)Registration of the list_envelopes tool as an MCP tool, handling the request and calling the API function.
server.tool( 'list_envelopes', 'List envelopes with optional status filter. Returns envelope IDs, names, and statuses.', { status: z.enum(['draft', 'sent', 'completed', 'expired', 'declined', 'cancelled']).optional().describe('Filter by status'), page: z.number().optional().describe('Page number (default 1)'), itemsPerPage: z.number().optional().describe('Items per page (default 10)'), }, async (params) => { try { const data = await api.listEnvelopes(creds, params); return result(data); } catch (err) { return errorResult(err); } } );