Actions100
- Activity Actions
- Asset Actions
- Authentication Actions
- Collection Actions
- Extension Actions
- Field Actions
- File Actions
- Folder Actions
- Item Actions
- Permission Actions
- Preset Actions
- Relation Actions
- Revision Actions
- Role Actions
- Setting Actions
- User Actions
- Utility Actions
Overview
This node is designed to list user data from a system, supporting flexible querying and output formatting options. It is useful in scenarios where you need to retrieve multiple user records with various filters, sorting, grouping, or aggregation applied. For example, it can be used to fetch all users for reporting, filter users by specific criteria, or export user lists in different file formats like CSV or JSON.
Properties
| Name | Meaning |
|---|---|
| Return All | Whether to return all matching user records or limit the number of results. |
| Limit | Maximum number of user records to return when "Return All" is false (range 1-100). |
| Split Into Items | Whether to output each element of an array as its own separate item. |
| JSON/RAW Parameters | Whether to provide query/body parameters via UI fields or as raw JSON input. |
| Body Parameters | Raw JSON or RAW body parameters for the request, used if JSON/RAW Parameters is enabled. |
| Additional Fields | Collection of optional fields to customize the query: |
| - Aggregate | Aggregation functions to perform calculations on sets of values (e.g., count, average, sum) on specified fields. |
| - Binary Property for Export Data | Name of the binary property where exported data will be saved. |
| - Deep (JSON) | Nested relational dataset parameters for deep queries. |
| - Export | Format to save the API response: CSV, JSON, or XML. |
| - File Name for Export Data | Filename (without extension) for the exported data file. |
| - Fields | Comma-separated list of fields to include in the returned user objects. |
| - Filter (JSON) | JSON conditions to filter the user collection. |
| - Group By | Field(s) to group results by, enabling grouped aggregation (e.g., "author", "year(publish_date)"). |
| - Meta | Metadata fields to include in the response. |
| - Offset | Number of items to skip before starting to collect the result set. |
| - Search | Text query to filter users containing the given string in any field. |
| - Sort | Comma-separated fields to sort by; prefix with "-" for descending order, "?" for random sorting. |
Output
The node outputs a JSON array of user objects matching the query criteria. Each object contains user data fields as requested or filtered by the input properties. If export is enabled, the node also outputs the data in the selected file format (CSV, JSON, or XML) saved under a binary property named as specified. This allows downstream nodes to handle the exported file directly.
Dependencies
- Requires connection to the target system's API that manages user data.
- Needs appropriate API authentication credentials configured in n8n to access user information.
- No additional external libraries are indicated beyond those bundled internally.
Troubleshooting
- Empty Results: Check filters, search terms, and limits to ensure they match existing user data.
- Invalid JSON Input: When using JSON/RAW parameters, ensure the JSON syntax is correct to avoid parsing errors.
- Export Failures: Verify the export format and filename are valid; ensure the binary property name does not conflict with other node outputs.
- API Authentication Errors: Confirm that the API key or token is correctly configured and has sufficient permissions to list users.
- Aggregation Issues: Ensure aggregation functions and fields exist and are supported by the backend API.
Links and References
- Refer to the API documentation of the user management system for details on available fields, filtering, sorting, and aggregation capabilities.
- n8n documentation on handling JSON parameters and binary data for exporting files.