Listmonk icon

Listmonk

Interact with a listmonk instance

Actions32

Overview

The node "Listmonk" allows interaction with a Listmonk instance, which is an open-source self-hosted newsletter and mailing list manager. The node supports various operations on different resources within Listmonk, such as managing lists, campaigns, media, templates, subscribers, and transactions.

Specifically, the List - Get operation retrieves paginated data from a mailing list resource. This is useful for scenarios where you want to fetch a subset of list entries, for example, to display or process a specific page of subscribers or mailing lists in your workflow.

Practical examples include:

  • Fetching the first page of mailing lists with a defined number of entries per page.
  • Paginating through all lists to synchronize them with another system.
  • Retrieving a manageable chunk of data to avoid overloading downstream processing nodes.

Properties

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

These properties control pagination when fetching list data, allowing users to specify which page of results they want and how many items each page contains.

Output

The node outputs JSON data representing the requested page of list entries from the Listmonk instance. The structure typically includes an array of list objects with their details, such as list IDs, names, descriptions, and other metadata relevant to each list.

If the node supports binary data output (not indicated here), it would represent attachments or media related to lists, but this is not applicable for the List - Get operation based on the provided code.

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 by removing any trailing slash from the domain credential and appending /api.
  • The node expects the Listmonk API to respond with JSON data.

Troubleshooting

  • Authentication errors: Ensure that the provided username and password credentials are correct and have sufficient permissions on the Listmonk instance.
  • Invalid page or perPage values: Passing non-positive numbers or excessively large values might cause errors or empty responses. Use sensible pagination parameters.
  • Network issues: Verify that the domain URL is reachable and the Listmonk server is running.
  • API changes: If the Listmonk API version changes, some endpoints or response formats might differ, causing unexpected behavior.

Links and References

Discussion