Mautic AdvancedInstall

Summary

Retrieve a list of campaigns from Mautic with optional filtering, sorting, and pagination.

Inputs

• Authentication (required) — Choose between Credentials or OAuth2 authentication methods.
• Return All (required) — Specify whether to return all campaign records or limit the number of results.
• Limit — Set the maximum number of campaigns to return when not returning all (minimum 1, default 50).
• Options — Additional parameters to customize the response, including minimal result data, sorting column and direction, filtering for published campaigns only, and search criteria.

Output shape

an array of campaign entities, with optional minimal data

If 'Return All' is false, results are limited by the 'Limit' parameter. 'Options' control filtering and sorting. The 'Minimal' option returns a simplified array of campaign entities without extra lists.

Examples

Example 1: Get up to 50 campaigns sorted by name in ascending order, returning detailed entity data.

Return All=false, Limit=50, Options={orderBy: 'name', orderByDir: 'asc', minimal: false}

Example 2: Retrieve all published campaigns with minimal data returned.

Return All=true, Options={publishedOnly: true, minimal: true}