Actions71
- Settings Actions
- Subscribers Actions
- Create Subscriber
- Manage Subscriber Lists By Query
- Get Subscribers
- Delete Subscriber By List
- Get Subscriber By Id
- Update Subscriber By Id
- Delete Subscriber By Id
- Manage Subscriber Lists
- Manage Subscriber List By Id
- Manage Blocklist By Subscriber List
- Manage Blocklist Subscribers By Id
- Export Subscriber Data By ID
- Get Subscriber Bounces By Id
- Delete Subscriber Bounces By Id
- Subscriber Send Optin By Id
- Delete Subscriber By Query
- Blocklist Subscribers Query
- Bounces Actions
- Import Actions
- Campaigns Actions
- Update Preview Campaign By Id
- Get Campaigns
- Create Campaign
- Get Campaign By Id
- Update Campaign By Id
- Delete Campaign By Id
- Get Running Campaign Stats
- Get Campaign Analytics
- Preview Campaign By Id
- Preview Campaign Text By Id
- Update Campaign Status By Id
- Update Campaign Archive By Id
- Create Campaign Content By Id
- Test Campaign By Id
- Media Actions
- Templates Actions
- Public Actions
- Miscellaneous Actions
- Admin Actions
- Logs Actions
- Lists Actions
- Transactional Actions
- Maintenance Actions
Overview
This node interacts with the Listmonk API to retrieve lists of mailing lists or subscriber lists. It supports fetching paginated results with options to filter, sort, and search lists by various criteria such as name, status, creation date, update date, and tags. This node is useful for automating the management and retrieval of mailing lists in marketing or communication workflows.
Use Case Examples
- Retrieve the first page of mailing lists with 20 items per page, sorted by name in ascending order.
- Search for lists containing a specific keyword in their name and filter by tags.
- Fetch lists with minimal response content to reduce data transfer when only metadata is needed.
Properties
| Name | Meaning |
|---|---|
| Page | Total number of pages to retrieve, used for pagination. |
| Per Page | Number of items to retrieve per page, controls the page size for pagination. |
| Query | Optional search string to filter lists by their name. |
| Order By | Field to sort the results by, such as name, status, creation date, or update date. |
| Order | Sort direction, either ascending (ASC) or descending (DESC). |
| Minimal | When true, returns the response without body content to reduce data size. |
| Tag | Tags to filter lists by; multiple tags can be specified in the query. |
| Request Options | Additional request settings such as batching, SSL certificate validation, proxy configuration, and timeout settings. |
Output
JSON
lists- Array of list objects retrieved from the API, each representing a mailing or subscriber list with its details.total- Total number of lists available matching the query criteria.page- Current page number of the paginated results.per_page- Number of items per page in the response.
Dependencies
- Requires an API key credential for authenticating with the Listmonk API.
Troubleshooting
- Ensure the base URL and API credentials are correctly configured to avoid authentication errors.
- If pagination parameters (page, per_page) are set incorrectly, the node may return empty or incomplete results.
- Setting 'Minimal' to true returns no body content, which might cause issues if the workflow expects list data.
- Network issues or proxy misconfiguration can cause request failures; verify proxy and timeout settings.
Links
- Listmonk API Documentation - Official documentation for the Listmonk API endpoints and parameters.