Listmonk

Interact with a listmonk instance

Actions32

Campaign Actions
List Actions
Media Actions
- Get Media by ID
- Delete Media by ID
Setting Actions
- Update Settings
- Test Smtp Settings
Subscriber Actions
Template Actions
Transaction Actions
- Send a Transactional Email

Overview

The node named "Listmonk" allows interaction with a Listmonk instance, which is an open-source self-hosted newsletter and mailing list manager. Specifically, the "Subscriber" resource with the "Get" operation enables users to retrieve subscriber data from the Listmonk system in a paginated manner.

This node is beneficial when you want to programmatically fetch subscribers for purposes such as exporting subscriber lists, syncing with other systems, or analyzing subscriber data. For example, you might use it to get the first 25 subscribers on page 1 to display in a dashboard or to process them in a workflow.

Properties

Name	Meaning
Page	The page number of subscriber results to query. Must be a positive integer (default: 1).
Per Page	The number of subscriber entries to retrieve per page. Controls the page size (default: 25).

These properties control pagination of the subscriber list retrieval.

Output

The output of this node will contain a JSON field with the subscriber data retrieved from the Listmonk API. This typically includes subscriber details such as email addresses, subscription status, and any associated metadata depending on the Listmonk API response structure.

No binary data output is indicated by the source code.

Dependencies

Requires connection to a Listmonk instance via its REST API.
Needs credentials including:
- The domain URL of the Listmonk instance.
- A username and password for basic authentication.
The base URL for API requests is constructed by trimming trailing slashes from the domain and appending /api.
HTTP headers specify JSON content type and acceptance.

Troubleshooting

Authentication errors: If the username or password is incorrect, the node will fail to authenticate. Verify credentials are correct.
Invalid domain URL: Ensure the domain URL does not have trailing slashes beyond what is expected, as the code trims trailing slashes before appending /api.
Pagination issues: Requesting pages beyond the available range may return empty results. Adjust Page and Per Page accordingly.
Network connectivity: The node requires network access to the Listmonk API endpoint; ensure firewall or network policies allow this.