Actions111
- Item Actions
- Webhook Actions
- Collection Actions
- File Actions
- Activity Actions
- Asset Actions
- Authentication Actions
- Extension Actions
- Field Actions
- Folder Actions
- Permission Actions
- Preset Actions
- Relation Actions
- Revision Actions
- Role Actions
- Setting Actions
- User Actions
- Utility Actions
Overview
This n8n node is designed to interact with a "Setting" resource, specifically performing the "Get" operation. It allows users to retrieve settings data from an external service or database, supporting advanced querying, filtering, aggregation, and export options. This node is beneficial in scenarios where you need to fetch configuration or system settings, analyze them, or export them for reporting or backup purposes.
Practical examples:
- Fetching all application settings for audit or review.
- Exporting settings data as CSV, JSON, or XML for documentation or migration.
- Applying filters or aggregations to analyze specific aspects of the settings (e.g., count of enabled features).
Properties
| Name | Meaning |
|---|---|
| JSON/RAW Parameters | Whether the query and/or body parameter should be set via the value-key pair UI or JSON/RAW. If enabled, you can input raw JSON for query parameters. |
| Query Parameters | Query parameters as JSON (flat object). Used when "JSON/RAW Parameters" is enabled. |
| Additional Fields | Collection of extra options to refine your query. Includes: - Aggregate: Perform calculations like count, sum, average, etc., on fields. - Binary Property for Export Data: Name of the binary property to store downloaded data. - Deep (JSON): Set nested query parameters for relational datasets. - Export: Save API response as json, csv, or xml. - File Name for Export Data: Specify file name (without extension) for exported data. - Fields: Control which fields are returned. - Filter (JSON): Select items by conditions. - Group By: Group results by specified fields. - Meta: Specify metadata to return. - Offset: Number of items to skip. - Search: Filter items containing a search query. - Sort: Define sorting order (CSV of fields, use '-' for descending, '?' for random). |
| Aggregate | Allows performing aggregation functions such as Average, Count, Maximum, Minimum, SUM, etc., on selected fields. Multiple aggregations can be defined. |
| Binary Property for Export Data | Name of the binary property to download/export the data to. |
| Deep (JSON) | Set additional query parameters for nested relational datasets using JSON. |
| Export | Choose format to save the API response: csv, json, or xml. |
| File Name for Export Data | Specify the file name (without extension) for the exported data. |
| Fields | Specify which fields to include in the returned objects. |
| Filter (JSON) | Apply conditions to select specific items using JSON. |
| Group By | Group results based on one or more fields (e.g., author, year). Useful for aggregated reports. |
| Meta | Specify what metadata to include in the response. |
| Offset | Skip a number of items when fetching data (for pagination). |
| Search | Filter items that contain the given search query in any field. |
| Sort | Define how to sort the returned items. Use a comma-separated list of fields; prefix with '-' for descending order, or use '?' for random sorting. |
Output
- The node outputs a
jsonfield containing the retrieved settings data, structured according to the query, filters, and fields specified. - If the "Export" option is used, the output may include a binary property (with the specified name) containing the exported file in the chosen format (csv, json, or xml).
Dependencies
- May require access to an external service or API endpoint for retrieving settings.
- API keys or authentication credentials might be necessary, depending on the backend service.
- No special n8n configurations are indicated in the static code, but ensure proper credentials are set up in n8n if required by the connected service.
Troubleshooting
- Invalid JSON Input: If you provide malformed JSON in properties like "Query Parameters", "Deep (JSON)", or "Filter (JSON)", the node may throw parsing errors. Double-check your JSON syntax.
- Missing Required Fields: Some fields are required depending on your configuration (e.g., "Query Parameters" when "JSON/RAW Parameters" is enabled). Ensure all mandatory fields are filled.
- Export Errors: If exporting data, make sure the "File Name for Export Data" and "Binary Property for Export Data" are valid and do not conflict with other nodes.
- API Authentication Issues: If the underlying service requires authentication, ensure credentials are correctly configured in n8n.