Actions12
List → Get All
AI-generatedOverview
This node operation fetches all lists from the Listmonk service. It supports optional pagination and sorting to control the volume and order of the returned lists. This is useful for scenarios where you need to retrieve and process multiple mailing lists, such as syncing lists with another system or displaying them in a dashboard.
Use Case Examples
- Fetch all lists without pagination or sorting to get a complete snapshot of available lists.
- Fetch lists with pagination to handle large numbers of lists efficiently, specifying page number and items per page.
- Fetch lists sorted by creation date or name to organize the output for reporting or user display.
Properties
| Name | Meaning |
|---|---|
| Use Pagination | Whether to paginate results, enabling control over page number and items per page. |
| Page | Page number to fetch when pagination is enabled. |
| Per Page | Number of results to return per page when pagination is enabled. |
| Use Sorting | Whether to sort the results by a specific field. |
| Sort by Field | Field to sort the results by, such as name, status, created_at, or updated_at. |
| Sort Direction | Direction to sort the results, ascending or descending. |
Output
JSON
lists- Array of list objects retrieved from the Listmonk service.
Dependencies
- Requires an API key credential for authenticating with the Listmonk service.
Troubleshooting
- Common issues include authentication failures due to invalid or missing API credentials.
- Pagination parameters out of range or invalid may cause errors or empty results.
- Sorting by unsupported fields may be ignored or cause errors depending on the API implementation.