Mautic AdvancedInstall

Summary

Retrieve multiple fields from Mautic for either contacts or companies with optional filtering, sorting, and pagination.

Inputs

• Authentication — Choose the authentication method to use: Credentials or OAuth2.
• Field Object (required) — Select whether to get fields for contact objects or company objects.
• Return All — Set to true to return all matching results; false to limit results.
• Limit — Maximum number of results to return when 'Return All' is false; minimum value is 1, default 50.
• Search — A string or search command to filter fields by matching text.
• Order By — Column name to sort the results by.
• Order By Direction — Sort direction, either ascending (ASC) or descending (DESC).
• Published Only — When true, only currently published fields are returned.
• Minimal — When true, returns only an array of fields without additional list metadata.

Output shape

a list of field objects with each object's properties depending on the selected 'Field Object' type; output may be filtered and paginated according to input parameters

If 'Return All' is false, the output is limited to the number specified by 'Limit'. Optional filters apply on Mautic API level. The 'Minimal' option reduces the returned data to arrays of fields, omitting extra info.

Examples

Example 1: Retrieve all contact fields with default sorting

Set 'Field Object' to 'Contact' and 'Return All' to true.

Example 2: Get up to 20 company fields published and sorted by name descending

Set 'Field Object' to 'Company', 'Return All' to false, 'Limit' to 20, 'Published Only' to true, 'Order By' to 'name', and 'Order By Direction' to 'DESC'.