Actions181
- Account Actions
- Get Account
- Create Account
- Update Email
- Update Name
- Update Password
- Update Phone
- Update Status
- Get Preferences
- Update Preferences
- List Sessions
- Delete Sessions
- Get Session
- Update Session
- Delete Session
- Create Anonymous Session
- Create Email/Password Session
- Create Magic URL Session
- Create OAuth2 Session
- Create Phone Session
- Create Session from Token
- Create JWT
- Create Magic URL
- Create Phone Token
- Create Email Verification
- Update Email Verification
- Create Phone Verification
- Update Phone Verification
- Create Password Recovery
- Update Password Recovery
- Create Recovery
- Update Recovery
- Update MFA
- Create MFA Authenticator
- Update MFA Authenticator
- Delete MFA Authenticator
- Create MFA Challenge
- Update MFA Challenge
- Attribute Actions
- Avatars Actions
- Collection Actions
- Database Actions
- Document Actions
- Functions Actions
- Index Actions
- Locale Actions
- Messaging Actions
- Sites Actions
- Storage Actions
- Teams Actions
- Users Actions
Document → List
AI-generatedOverview
This node interacts with the Appwrite API to perform operations on documents within a specified database and collection. Specifically, the 'List' operation under the 'Document' resource retrieves a list of documents from a given database and collection. This is useful for scenarios where you need to fetch and process multiple documents stored in Appwrite, such as displaying records, data analysis, or further automation workflows.
Use Case Examples
- Fetching all user profiles stored in a 'users' collection within a database.
- Retrieving a list of orders from an 'orders' collection for processing or reporting.
Properties
| Name | Meaning |
|---|---|
| Database ID | The ID of the database from which to list documents. |
| Collection ID | The ID of the collection within the database from which to list documents. |
Output
JSON
documents- An array of document objects retrieved from the specified database and collection.
Dependencies
- Requires an Appwrite API key credential with access to the specified project and database.
Troubleshooting
- Ensure the provided Database ID and Collection ID are correct and exist in the Appwrite project.
- Verify that the API key has sufficient permissions to read documents from the specified database and collection.
- Common errors include authentication failures due to invalid API keys or permission issues, and resource not found errors if the database or collection IDs are incorrect.
Links
- Appwrite Database Documents API - Official documentation for managing documents in Appwrite databases.