Actions58
- Lead Management Actions
- User Agent Management Actions
- Campaign Management Actions
- Phone DID Management Actions
- List Management Actions
- Reporting Monitoring Actions
- System Info Actions
- Other Operations Actions
Overview
This node interacts with a campaign management API to retrieve a list of campaigns. It is designed to fetch campaign data based on various input parameters such as user credentials, campaign ID, output format, and more. This node is useful in scenarios where you want to automate the retrieval and processing of campaign information from an external system, for example, to integrate campaign data into workflows for reporting, analytics, or further automation.
Practical examples include:
- Automatically fetching all active campaigns for monitoring purposes.
- Retrieving specific campaign details by ID to trigger follow-up actions.
- Exporting campaign lists in different formats (CSV, JSON, etc.) for integration with other tools.
Properties
| Name | Meaning |
|---|---|
| Function | API function name; fixed to "Campaigns List" for this operation. |
| User | API user credential used for authentication. |
| Pass | API password credential used for authentication. |
| Source | Description of what originated the API call; default is "n8n". |
| Campaign Id | Optional filter to specify a particular campaign by its ID. |
| Stage | Output format of the campaign list; options are Csv, Tab, Pipe, Json. |
| Header | Whether to include a header row in the output; options are YES or NO. |
Output
The node outputs the campaign list data in the json field of the output items. The structure depends on the selected output format (stage property):
- If the output format is
json, the data will be structured as JSON objects representing campaigns. - For other formats (
csv,tab,pipe), the output will be text formatted accordingly, optionally including headers if enabled.
If binary data output is supported (not explicitly shown here), it would represent the raw formatted data file corresponding to the chosen output format.
Dependencies
- Requires an API key credential (user and password) for authenticating with the campaign management API.
- The node sends HTTP requests to the configured base URL of the campaign management system.
- No additional external dependencies beyond standard HTTP request capabilities.
Troubleshooting
- Authentication errors: Ensure that the provided user and password credentials are correct and have sufficient permissions.
- Invalid campaign ID: If filtering by campaign ID, verify that the ID exists and is correctly formatted.
- Output format issues: Selecting an unsupported or misspelled output format may cause unexpected results.
- Network connectivity: Confirm that the API endpoint is reachable from the n8n instance.
- Missing required parameters: The function, user, and pass properties are mandatory; missing these will cause errors.
Common error messages might include authentication failures, invalid parameter errors, or network timeouts. Resolving them typically involves verifying credentials, input values, and network access.
Links and References
- Refer to your campaign management API documentation for detailed descriptions of parameters and response formats.
- n8n documentation on HTTP Request nodes and credential management for setting up API connections.