Listmonk icon

Listmonk

Interact with a listmonk instance

Overview

The node interacts with a Listmonk instance, specifically allowing users to retrieve campaign data. The "Get" operation under the "Campaign" resource fetches a paginated list of campaigns from the Listmonk API. This is useful for scenarios where you want to programmatically access and process campaign information such as in marketing automation workflows, reporting, or synchronization tasks.

For example, you might use this node to:

  • Retrieve the first page of campaigns to display in a dashboard.
  • Fetch subsequent pages of campaigns in a loop to aggregate all campaign data.
  • Integrate campaign data into other systems like CRMs or analytics platforms.

Properties

Name Meaning
Page The page number of campaign results to query (e.g., 1 for the first page).
Per Page The number of campaign items to retrieve per page (e.g., 25 campaigns per request).

Output

The output contains a JSON field representing the retrieved campaigns. This typically includes an array of campaign objects with their details such as IDs, names, statuses, and other metadata provided by the Listmonk API. The structure aligns with the Listmonk campaign data schema.

No binary data output is indicated for this operation.

Dependencies

  • Requires connection to a Listmonk instance via its API.
  • Needs credentials including domain URL, username, and password for basic authentication.
  • The base URL for API requests is constructed from the provided domain credential.
  • The node expects the Listmonk API to be accessible and responsive.

Troubleshooting

  • Authentication errors: Ensure that the API credentials (domain, username, password) are correct and have sufficient permissions.
  • Pagination issues: If no campaigns are returned, verify that the Page and Per Page values are within valid ranges and that campaigns exist on those pages.
  • Network errors: Confirm that the Listmonk instance is reachable from the n8n environment.
  • API changes: If the Listmonk API changes, the node may fail; check for updates or compatibility notes.

Links and References

Discussion