Actions84
- Avatar Actions
- Document Actions
- Function Actions
- Messaging Actions
- Create APNS Provider
- Create Email
- Create FCM Provider
- Create Mailgun Provider
- Create MSG91 Provider
- Create Provider
- Create Push
- Create Sendgrid Provider
- Create SMS
- Create SMTP Provider
- Create Subscriber
- Create Telesign Provider
- Create Textmagic Provider
- Create Topic
- Create Twilio Provider
- Create Vonage Provider
- Delete Provider
- Delete Subscriber
- Delete Topic
- Get Message
- Get Provider
- Get Subscriber
- Get Topic
- List Message Logs
- List Messages
- List Provider Logs
- List Providers
- List Subscriber Logs
- List Subscribers
- List Targets
- List Topic Logs
- List Topics
- Update APNS Provider
- Update Email
- Update FCM Provider
- Update Mailgun Provider
- Update MSG91 Provider
- Update Provider
- Update Push
- Update Sendgrid Provider
- Update SMS
- Update SMTP Provider
- Update Telesign Provider
- Update Textmagic Provider
- Update Topic
- Update Twilio Provider
- Update Vonage Provider
- Storage Actions
- Token Actions
- Users Actions
Overview
The "List Users" operation of the ZAppwrite node allows you to retrieve a list of users from an Appwrite backend. This operation supports filtering the user list by applying various query filters, enabling precise control over which users are returned.
This node is beneficial when you want to automate workflows that involve managing or analyzing user data stored in Appwrite. For example, you could use it to:
- Retrieve all users who signed up within a specific date range.
- Filter users based on custom attributes or metadata.
- Paginate through large sets of users for batch processing.
Properties
| Name | Meaning |
|---|---|
| Additional Fields | Queries to filter the users by. You can add multiple queries with different conditions to narrow down the results. Supported query types include: Between, Cursor After, Cursor Before, Ends With, Equal, Greater Than, Greater Than or Equal, Is Not Null, Is Null, Less Than, Less Than or Equal, Limit, Not Equal, Offset, Order Ascending, Order Descending, Search, Select, Starts With. Each query requires specifying the index (attribute), values, and the type of query. |
Output
The output is a JSON array containing the list of users matching the specified filters. Each user object includes user details as provided by the Appwrite API. The exact structure depends on the Appwrite user schema but typically includes fields like user ID, email, name, phone, and other metadata.
No binary data output is produced by this operation.
Dependencies
- Requires an active connection to an Appwrite server.
- Requires credentials including the Appwrite endpoint URL, project ID, and an API key credential with permissions to list users.
- The node uses the official Appwrite SDK internally to communicate with the Appwrite API.
Troubleshooting
Common issues:
- Incorrect or missing credentials will cause authentication failures.
- Using unsupported or malformed queries may result in errors or empty results.
- Network connectivity issues to the Appwrite server will prevent successful API calls.
Error messages:
- Authentication errors indicate invalid or expired API keys; verify and update credentials.
- Query syntax errors suggest incorrect filter parameters; review the query definitions carefully.
- Timeout or network errors require checking the Appwrite server availability and network settings.
Links and References
- Appwrite Filters Documentation — Detailed explanation of supported query filters.
- Appwrite Users API Reference — Official API documentation for user management endpoints.