Listmonk icon

Listmonk

Interact with Listmonk API

Actions71

Overview

This node interacts with the Listmonk API to retrieve subscriber data. It is designed to fetch subscribers with support for pagination, filtering, sorting, and querying. This node is useful for scenarios where you need to manage or analyze subscriber lists, such as marketing campaigns, user engagement tracking, or data synchronization between systems.

Use Case Examples

  1. Retrieve the first page of subscribers with default sorting by name.
  2. Fetch all subscribers across all pages by setting 'Per Page' to 'all'.
  3. Query subscribers with specific criteria using an SQL expression in the 'Query' field.
  4. Filter subscribers by subscription status or specific list IDs to target particular segments.

Properties

Name Meaning
Page Page number for paginated results.
Per Page Number of items per page. Use an integer for specific page size or 'all' to retrieve all results.
Query Query subscribers with an SQL expression to filter results.
Order By Field to sort the results by. Options include name, status, created_at, updated_at.
Order Sort order direction, either ascending (ASC) or descending (DESC).
Subscription Status Filter subscribers by their subscription status when filtering by list IDs.
List Id Filter subscribers by one or more list IDs. Multiple values can be specified.
Request Options Additional request settings including batching, SSL certificate validation, proxy configuration, and request timeout.

Output

JSON

  • subscribers - Array of subscriber objects returned from the API, containing subscriber details such as name, status, and timestamps.

Dependencies

  • Requires an API key credential for authenticating with the Listmonk API.

Troubleshooting

  • Ensure the API base URL and credentials are correctly configured to avoid authentication errors.
  • If pagination parameters are incorrect, the node may return empty or incomplete results; verify 'Page' and 'Per Page' values.
  • Using an invalid SQL expression in the 'Query' property may cause API errors; validate the query syntax.
  • Network issues or proxy misconfiguration can cause request failures; check proxy settings and network connectivity.
  • If SSL certificate validation fails and 'Ignore SSL Issues' is not enabled, requests will be blocked; enable this option only if you trust the endpoint.

Discussion