Actions12
- Document Actions
- Template Actions
- Webhook Actions
Document → Get
AI-generatedOverview
This node interacts with the SignWell API to retrieve detailed information about a specific document using its Document ID. It is useful in scenarios where you need to fetch the current status, metadata, or content details of a document managed within SignWell, such as verifying document status before further processing or displaying document details in an application.
Use Case Examples
- Retrieve a document's details by providing its Document ID to check its signing status.
- Fetch document metadata to display in a dashboard or for audit purposes.
Properties
| Name | Meaning |
|---|---|
| Document ID | The unique identifier of the document to retrieve. This is a required input for the 'Get' operation on the Document resource. |
Output
JSON
id- The unique identifier of the document.status- The current status of the document (e.g., pending, completed).title- The title or name of the document.created_at- Timestamp when the document was created.updated_at- Timestamp when the document was last updated.recipients- List of recipients associated with the document, including their roles and statuses.fields- Details of fields within the document, such as signature fields or text fields.
Dependencies
- Requires an API key credential for SignWell API authentication.
Troubleshooting
- Ensure the Document ID provided is correct and exists in the SignWell account.
- Check that the API key credential is valid and has the necessary permissions to access document data.
- If the document is not found, the API may return a 404 error; verify the document ID and try again.
Links
- SignWell API Documentation - Official API documentation for SignWell, including endpoints for document retrieval.