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. Specifically, the "Document" resource with the "List" operation allows users to retrieve multiple documents filtered by custom queries from a given collection in a database.
Common scenarios include:
- Fetching all documents or a subset of documents matching certain criteria from an Appwrite collection.
- Automating workflows that require processing or analyzing data stored in Appwrite databases.
- Integrating Appwrite document retrieval into larger automation pipelines for data synchronization or reporting.
For example, you might use this node to list all blog posts with a specific title or tag by providing appropriate query filters.
Properties
| Name | Meaning |
|---|---|
| Database ID | The identifier of the database containing the target collection. |
| Collection ID | The identifier of the collection within the database where documents are stored. |
| Queries | A JSON array of query strings used to filter the documents returned. Example: ["equal(\"title\", [\"Post 1\"])"] |
Output
The node outputs a JSON array where each element represents a document retrieved from the specified collection. Each document object contains its fields and metadata as provided by the Appwrite API.
There is no binary output for this operation.
Dependencies
- Requires an active connection to the Appwrite API via an API key credential configured in n8n.
- The node depends on the Appwrite client library internally to communicate with the Appwrite server.
- Proper permissions must be set on the Appwrite side to allow reading documents from the specified database and collection.
Troubleshooting
- Empty results: If the output array is empty, verify that the database ID, collection ID, and query filters are correct and that documents matching the queries exist.
- Invalid queries: Malformed JSON or incorrect query syntax in the "Queries" property can cause errors. Ensure queries are valid Appwrite query expressions formatted as strings inside a JSON array.
- Authentication errors: If the node fails due to authentication, check that the API key credential is correctly configured and has sufficient permissions.
- API errors: Errors returned from the Appwrite API will be surfaced with messages. Review these messages for details such as missing resources or permission issues.