List segments
pushengage_list_segmentsList push notification audience segments with subscriber counts, status, and URL match criteria. Paginate through results to browse all segments for the selected site.
Instructions
Lists segments on the current site, paginated (response includes has_more). Each item carries segment_id, name, current subscriber count, status, and any URL matching criteria.
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 (segments 101–200) is page=2. | |
| limit | No | How many segments 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 case-insensitive substring filter on segment_name. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| limit | No | ||
| total | No | ||
| has_more | No | ||
| segments | No | ||
| last_page | No |