List audience groups
pushengage_list_audience_groupsList audience groups with pagination and name filtering to retrieve audience-group IDs for sending push notifications.
Instructions
Lists audience groups on the current site, paginated (response includes has_more). Use this to look up audience-group IDs when the user references a group by name; those IDs are what pushengage_send_notification / pushengage_send_ab_notification accept in their audience_groups field.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number (1-indexed) for paginating beyond the first batch. e.g. with limit=100 the second page (101–200) is page=2. | |
| limit | No | How many audience groups to return in this page. Min 1, max 100, default 10. To browse past the first 100, increase `page` instead of asking for a larger limit. | |
| site_id | No | Override the currently selected site. | |
| name_contains | No | Optional substring filter on the audience-group name. Maps to API `name_like`. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| limit | No | ||
| total | No | ||
| has_more | No | ||
| last_page | No | ||
| audience_groups | No |