NAppwrite icon

NAppwrite

Use Appwrite's API from inside N8N, updated by @ZachHandley
Join our community

Actions25

Overview

This node integrates with Appwrite's Document service to retrieve multiple documents from a specified database collection. It is designed to fetch all documents matching optional query filters, enabling users to efficiently list and filter documents stored in Appwrite databases.

Common scenarios include:

  • Retrieving all records from a collection for reporting or processing.
  • Filtering documents based on attribute values, ranges, or text search.
  • Paginating through large datasets using cursor or offset queries.

Practical example:

  • Fetching all user profiles from a "users" collection where the "status" attribute equals "active".
  • Listing documents created within a date range using a "between" query on a timestamp attribute.

Properties

Name Meaning
Database ID The identifier of the Appwrite database containing the target collection.
Collection ID The identifier of the collection within the database from which to list documents.
Additional Fields Optional queries to filter the documents by various criteria. Supports multiple query types such as: Between, Contains, Cursor After/Before (for pagination), Ends With, Equal, Greater Than, Less Than, Limit, Offset, Order Ascending/Descending, Search, Select, Starts With, Is Null, Is Not Null, Not Equal. Each query can specify an index, one or two values depending on the query type.

Output

The node outputs an array of JSON objects representing the documents retrieved from the specified collection. Each object corresponds to a document with its attributes as key-value pairs.

  • The json output field contains the list of documents matching the query filters.
  • No binary data output is produced by this operation.

Dependencies

  • Requires an active Appwrite project with API access configured.
  • Needs credentials including the Appwrite endpoint URL, project ID, and an API key with permissions to read documents.
  • The node uses the official Appwrite SDK internally to communicate with the Appwrite server.

Troubleshooting

  • Common issues:

    • Invalid or missing Database ID or Collection ID will cause errors; ensure these IDs are correct and exist in your Appwrite project.
    • Improperly formatted queries may result in no documents returned or errors; verify query parameters conform to Appwrite's filtering syntax.
    • Insufficient API permissions can lead to authorization errors; confirm the API key has read access to the database and collection.

  • Error messages:

    • Errors related to authentication typically indicate invalid credentials or insufficient permissions.
    • Query-related errors may mention unsupported indexes or invalid query parameters; check that the indexes used in queries exist and are correctly named.
    • Network or connection errors suggest issues reaching the Appwrite server; verify the endpoint URL and network connectivity.

Links and References

Discussion