Actions44
- User Actions
- Database Actions
- Collection Actions
- Document Actions
- Index Actions
- Function Actions
- Storage Actions
Overview
This node integrates with the Appwrite API to manage documents within a specified database and collection. The Document: Get operation retrieves a single document by its unique ID from a given database and collection.
Common scenarios where this node is useful include:
- Fetching detailed information about a specific record stored in an Appwrite database.
- Retrieving data for further processing or conditional logic in an automation workflow.
- Integrating Appwrite document data into other systems or services via n8n.
For example, you might use this node to get a user profile document by its ID after a trigger event, then use that data to send a personalized email.
Properties
| Name | Meaning |
|---|---|
| Database ID | The identifier of the database containing the target collection. |
| Collection ID | The identifier of the collection within the database that holds the document. |
| Document ID | The unique identifier of the document to retrieve. Use "unique()" to auto-generate IDs when creating documents (not applicable here). |
Output
The node outputs a JSON object representing the retrieved document. This JSON includes all fields and metadata of the document as stored in Appwrite.
If the document is successfully fetched, the output will be a single JSON object with the document's data.
No binary data output is produced by this operation.
Dependencies
- Requires an active connection to the Appwrite API using an API key credential configured in n8n.
- The node depends on the Appwrite client library bundled within the node implementation.
- Proper permissions must be granted to the API key to access the specified database, collection, and document.
Troubleshooting
Common issues:
- Invalid or missing Database ID, Collection ID, or Document ID parameters will cause errors.
- Insufficient permissions for the API key to read documents in the specified collection.
- Network connectivity issues or incorrect Appwrite endpoint configuration.
Error messages:
- Errors returned from the Appwrite API are wrapped and presented with details if available.
- Typical error messages include "Document not found" if the document ID does not exist.
- Authentication errors if the API key is invalid or lacks required scopes.
Resolutions:
- Verify all IDs are correct and correspond to existing resources.
- Ensure the API key has read access to the database and collection.
- Check network connectivity and Appwrite server availability.