mailerpress-pro/list-segments returns a paginated list of MailerPress Pro segments, with an optional search on the name.
A segment is a saved set of conditions rather than a saved set of contacts.
At a glance
| Ability | mailerpress-pro/list-segments |
| Toolset | MailerPress Pro — toolset/mailerpress-pro |
| Group | MailerPress Pro › Segments |
| Requires | AcrossAI Pro, plus MailerPress with its Pro add-on active on the site |
| Capability | manage_options |
| Safety | Read-only — changes nothing |
| Repeatable | Idempotent — running it twice leaves the same result |
| Ships in | AcrossAI Pro 0.9.16 and later |
How it works
That distinction is the thing to hold on to. A list is a fixed membership — contacts are added and removed. A segment is a query evaluated when it is used, so its membership changes as the contacts do, without anybody touching it.
Which means a segment named “Lapsed customers” can be empty today and hold four hundred people next month, and nothing was edited.
This read returns the segments and their definitions rather than their current members. For members, mailerpress-pro/get-segments-for-contact evaluates a named segment and returns who currently satisfies it.
Searching by name is the only filter. Segments accumulate on an established install, and the names are the only thing distinguishing “Active 30d” from “Active 30 days”.
Input
| Name | Type | Required | What it is |
|---|---|---|---|
search | string | No | Search on the segment name. |
per_page | integer | No | Rows per page. |
page | integer | No | Page number. |
What comes back
| Name | Type | What it is |
|---|---|---|
segments | array | Each segment with its name and conditions. |
total | integer | How many exist. |
success | boolean | Whether the call completed. |
message | string | A one-line summary of what happened, suitable for showing a human. |
error_code | string | Present only on failure — a stable machine-readable reason, such as a missing field, a wrong field type or an unmet confirmation. |
Example
Ask your assistant:
What segments do we have in MailerPress?
It resolves to one call:
{
"ability": "mailerpress-pro/list-segments",
"parameters": {}
}Worth knowing
- A segment is a query, not a membership. It changes as contacts do.
- This returns definitions; use the contacts read for current members.
- Name is the only filter, and near-duplicate names are common.
- Read-only.
Related abilities
- MailerPress Pro Contacts In A Segment — who is in one now
- MailerPress Pro Create Segment — add one
- MailerPress Pro Segment Condition Metadata — the vocabulary they are built from
Get the plugins:
AcrossAI Abilities Manager · AcrossAI MCP Manager
Browse the rest: Every ability, by category