mailerpress-pro/list-custom-fields returns every registered contact custom-field definition: its key, label, type and options.
The key is what matters most, because it is the storage key everything else uses.
At a glance
| Ability | mailerpress-pro/list-custom-fields |
| Toolset | MailerPress Pro — toolset/mailerpress-pro |
| Group | MailerPress Pro › Contact Custom Fields |
| 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
Custom fields extend a contact beyond email and name — a company, a plan tier, a signup source. They are also what segments filter on and what campaigns personalise with, so the key appears in three different places.
Reading the definitions is therefore the step before writing a contact, before authoring a segment condition on a custom field, and before using a personalisation token in a campaign.
The type governs what values are accepted and how a segment can compare them. A field stored as text cannot be compared numerically, which is the usual reason a “greater than” condition on a custom field matches nothing.
Options come back for the field types that have them, which is what tells you the exact strings a select-type field will accept.
Read-only.
Input
This ability takes no input.
What comes back
| Name | Type | What it is |
|---|---|---|
fields | array | Each definition with its key, label, type and options. |
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 custom fields do our contacts have?
It resolves to one call:
{
"ability": "mailerpress-pro/list-custom-fields",
"parameters": {}
}Worth knowing
- The key is the storage key, the segment key and the personalisation token.
- The type decides how a segment can compare the value.
- Options tell you the exact accepted strings.
- Read-only.
Related abilities
- MailerPress Pro Create Custom Field — add one
- MailerPress Pro Segment Condition Metadata — how these become conditions
Get the plugins:
AcrossAI Abilities Manager · AcrossAI MCP Manager
Browse the rest: Every ability, by category