Actions118
- Item Actions
- Activity Actions
- Asset Actions
- Authentication Actions
- Collection Actions
- Extension Actions
- Field Actions
- File Actions
- Folder Actions
- Permission Actions
- Preset Actions
- Relation Actions
- Revision Actions
- Role Actions
- Server Actions
- Setting Actions
- User Actions
- Utility Actions
- Webhook Actions
User → List
AI-generatedOverview
This node operation lists users from a data source, providing options to return all users or limit the number of results. It supports advanced filtering, sorting, grouping, and aggregation of user data. Users can also export the results in various formats such as JSON, CSV, or XML. This operation is useful for scenarios where you need to retrieve user information for reporting, analysis, or integration with other systems.
Use Case Examples
- Retrieve all users in the system for a comprehensive report.
- Fetch a limited number of users with specific filters applied, such as those created after a certain date.
- Export user data to a CSV file for offline analysis.
- Aggregate user data to count the number of users per role or group.
Properties
| Name | Meaning |
|---|---|
| Return All | Whether to return all user results or only up to a given limit. |
| Limit | Maximum number of user results to return when not returning all. |
| Split Into Items | Whether to output each element of an array as its own item. |
| JSON/RAW Parameters | Whether the query and/or body parameters should be set via the value-key pair UI or JSON/RAW input. |
| Body Parameters | Body parameters as JSON or RAW input for advanced query customization. |
| Additional Fields | Additional optional fields to customize the user list operation, including aggregation functions, export options, filtering, sorting, grouping, and metadata. |
Output
JSON
users- Array of user objects returned from the list operation.exportedFile- Binary data of the exported user list file if export option is used.
Dependencies
- Requires connection to a Directus API or similar user management API with appropriate authentication credentials.
Troubleshooting
- Ensure the API credentials are valid and have permission to list users.
- If using JSON/RAW parameters, verify the JSON syntax is correct to avoid parsing errors.
- When limiting results, ensure the limit value is within the allowed range (1-100).
- If export fails, check that the specified file format is supported and the binary property name is correctly set.