Mautic: List Segments¶
Plugin ID: mautic_eca_list_segments
List segments in the selected Mautic connection.
Retrieves a list of segments from Mautic with optional filtering, sorting, and pagination. This action is useful for bulk operations and data synchronization.
Search Examples¶
- By Name:
name:Newsletter - By Description:
description:subscribers - By Date:
dateAdded:2024-01-01 - By Published:
isPublished:true - Multiple Criteria:
name:Newsletter AND isPublished:true
Fields¶
Mautic connection— config key:mautic_connection-
Select the Mautic connection to use for this action.
Type:
select· Required: yes · Default: empty string Name of token— config key:token_name-
Provide the name of a token where the value should be stored. Please provide the token name only, without brackets.
Type:
textfield· Required: no · Default: empty string Search filter— config key:search-
String or search command to filter segments by. Supports tokens.
Type:
textfield· Required: no · Default: empty stringSearch command to filter segments by name or other criteria. Supports tokens and basic search operators.
Start— config key:start-
Starting row for the segments returned.
Type:
number· Required: no · Default:0 Limit— config key:limit-
Limit number of segments to return. 0 to return all.
Type:
number· Required: no · Default:30 Order by— config key:order_by-
Column to sort by. Can use any column listed in the response.
Type:
textfield· Required: no · Default: empty string Sort direction— config key:order_by_dir-
Sort direction: asc or desc.
Type:
select· Required: yes · Default:ASCAllowed values:
ASC,DESC Published only— config key:published_only-
Only return currently published segments.
Type:
checkbox· Required: no · Default:false Minimal— config key:minimal-
Return only array of segments without additional lists in it.
Type:
checkbox· Required: no · Default:false