Appwrite icon

Appwrite

Interact with Appwrite API

Actions181

Document → Get

AI-generated

Overview

This node interacts with the Appwrite API to perform operations on documents within a specified database and collection. Specifically, the 'Get' operation retrieves a document by its ID from a given database and collection. This is useful for workflows that need to fetch and process specific document data stored in Appwrite databases, such as retrieving user profiles, order details, or configuration settings.

Use Case Examples

  1. Fetch a user profile document by its ID to personalize a user experience.
  2. Retrieve an order document to process or update order status in an e-commerce workflow.

Properties

Name Meaning
Database ID The ID of the database from which to retrieve the document.
Collection ID The ID of the collection within the database containing the document.
Document ID The ID of the specific document to retrieve.

Output

JSON

  • documentId - The unique identifier of the retrieved document.
  • collectionId - The ID of the collection containing the document.
  • databaseId - The ID of the database containing the collection.
  • data - The content or fields of the retrieved document as a JSON object.

Dependencies

  • Appwrite API key credential for authentication, including endpoint URL, project ID, and API key.

Troubleshooting

  • Common issues include invalid or missing IDs for database, collection, or document, resulting in errors from the Appwrite API.
  • Authentication errors due to incorrect or expired API keys or project IDs.
  • Network connectivity issues preventing access to the Appwrite endpoint.
  • Error messages typically indicate the nature of the failure, such as 'Document not found' or 'Unauthorized', and can be resolved by verifying input parameters and credentials.

Links

Discussion