get_envelope
Retrieve envelope details including status, recipients, and documents for digital signature management.
Instructions
Get detailed information about a specific envelope including status, recipients, documents.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| envelopeId | Yes | Envelope UUID |
Implementation Reference
- src/index.js:62-76 (handler)The tool registration and handler implementation for "get_envelope" which calls the api helper.
server.tool( 'get_envelope', 'Get detailed information about a specific envelope including status, recipients, documents.', { envelopeId: z.string().describe('Envelope UUID'), }, async ({ envelopeId }) => { try { const data = await api.getEnvelope(creds, envelopeId); return result(data); } catch (err) { return errorResult(err); } } ); - src/api.js:79-81 (helper)The underlying API call implementation for fetching an envelope.
export function getEnvelope(creds, envelopeId) { return apiCall('GET', `/api/envelopes/${envelopeId}`, creds); }