Query supporters
query_supportersFind and page through Engaging Networks supporters by creation/modification date, suppression status, saved profile, or custom search filters; returns IDs, dates, and optional emails.
Instructions
List supporters matching one of the API's queries: latestCreated or latestModified (optionally within days_back, 1-32), suppressed, profile (needs profile_id, a supporter profile built in the dashboard) or search (needs filter, e.g. 'firstName:Bobcountry:GB||US': ':' is equals, '||' is OR between values, '' adds another filter with AND). Returns supporter IDs with created and modified dates; email addresses only with include_contact_details. Pages through the results 100 at a time.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| type | Yes | The query to run | |
| start | No | Row to start from (to continue a previous call) | |
| filter | No | Filter for type 'search', as fieldName:value with '||' for OR and '~' to add filters | |
| days_back | No | Number of days of data to return (1-32) | |
| profile_id | No | Supporter profile ID (required for type 'profile') (numeric) | |
| max_results | No | Maximum number of supporters to return | |
| include_contact_details | No | Include each supporter's email address |