Actions25
- Document Actions
- Function Actions
- Storage Actions
- Users Actions
Overview
The "List Users" operation of the NAppwrite 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 in scenarios where you need to manage or analyze user data stored in Appwrite, such as:
- Fetching users who meet specific criteria (e.g., users created within a date range).
- Paginating through large sets of users.
- Searching for users based on attributes like email or name.
For example, you could use this node to list all users whose email ends with "@example.com" or to retrieve users created after a certain date.
Properties
| Name | Meaning |
|---|---|
| Additional Fields | Queries to filter the users by. These queries allow you to specify conditions such as: 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 can specify an index (attribute), one or two values depending on the query type, and the query operator. |
Details of Query Options (for Additional Fields)
- Between: Returns users if attribute value falls between two values (inclusive).
- Cursor After / Cursor Before: Used for pagination by placing cursor relative to a resource ID.
- Ends With / Starts With: Filters string attributes ending or starting with a substring.
- Equal / Not Equal: Matches attribute equal or not equal to any value in provided array.
- Greater Than / Greater Than or Equal / Less Than / Less Than or Equal: Numeric or string comparisons.
- Is Null / Is Not Null: Checks if attribute is null or not.
- Limit: Limits number of results returned (default is 25 if not specified).
- Offset: Skips a number of results (used for pagination).
- Order Ascending / Order Descending: Orders results by attribute.
- Search: Full-text search on string attributes (requires full-text index).
- Select: Specifies which attributes should be returned.
Output
The output is a JSON array containing user objects that match the specified filters. Each user object typically includes standard user properties such as user ID, email, name, phone, and other metadata managed by Appwrite.
No binary data output is produced by this operation.
Dependencies
- Requires an active connection to an Appwrite backend.
- Requires credentials including the Appwrite API 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 API credentials will cause authentication failures.
- Using unsupported or incorrectly formatted queries may result in errors or empty results.
- Pagination queries (cursor_after, cursor_before) require valid resource IDs; invalid IDs will cause errors.
- Lack of required indexes on attributes used in order or search queries may lead to errors or ignored filters.
Error Messages:
- Authentication errors: Verify API key and project ID.
- Query format errors: Ensure queries follow the expected structure and use supported operators.
- Resource not found or permission denied: Check that the API key has sufficient permissions to list users.