ActiveCampaign MCP - Available Tools
The ActiveCampaign remote MCP server exposes 396 tools: 90 core tools, plus 306 API catalog tools that each map to a single ActiveCampaign v3 API endpoint. To connect a client, see ActiveCampaign Remote MCP Server.
Type is Read for tools that only retrieve data and Write for tools that create or change data. The tools available to a connection depend on the connected user's permissions in ActiveCampaign; the tool list your MCP client receives from the server is authoritative.
Use Cases
The tools you're most likely to use, grouped by what you want to do, with examples of what you can ask.
-
Campaign reporting
Ask: "Compare my one-time campaigns from the last 30 days by sends, opens, clicks, bounces, and unsubscribes."
Tools:
run_campaign_performance_report,list_campaigns,get_campaign,get_campaign_links -
Create and revise emails
Ask: "Create a draft campaign for my fall promotion," or "Make the subject line shorter."
Tools:
generate_campaign,edit_campaign,copy_campaign,list_campaign_templates,get_campaign_history -
Find and update contacts
Ask: "Find this customer by email and update their phone number."
Tools:
list_contacts,get_contact, contact creation and field-value tools -
Tags and lists
Ask: "Add the 'Jotform Contact' tag," or "Show my email lists."
Tools:
list_tags,add_tag_to_contact,list_lists,create_list, contact-list membership tools -
Segments and engagement
Ask: "Find contacts who clicked a campaign," or "Check this contact's engagement."
Tools: Segment tools,
list_email_activities,get_top_contacts,get_contact_score_values -
Automations
Ask: "Show my active automations," or "Check whether this contact entered one."
Tools:
list_automations,list_contact_automations,get_contact_automation,add_contact_to_automation -
Deals and pipelines
Ask: "Show open deals in this stage," or "Add a note to a deal."
Tools:
list_deals,create_deal,get_deal,create_deal_note, pipeline and stage tools -
Fields and custom data
Ask: "Check whether a 'Form source' field exists."
Tools:
list_contact_custom_fields,create_contact_custom_field, custom-object schema and record tools -
Assets and account setup
Ask: "Find an image for my campaign," or "Show configured webhooks."
Tools: Brand-kit, template, content-manager image, tracking, form, webhook, and permission tools
Core Tools
Purpose-built tools for the most common ActiveCampaign tasks, grouped by area.
Account
Identify the connected account and check account-level settings.
| Tool | Type | Description |
|---|---|---|
get_profile | Read | Identify the ActiveCampaign account connected through the current credentials. |
is_phone_only_contacts_enabled | Read | Check whether the account allows contacts with a phone number and no email address. |
Contacts
Find, create, and update contacts, and look up their activity, scores, and imports.
| Tool | Type | Description |
|---|---|---|
list_contacts | Read | Retrieve contacts with advanced filtering (segment, form, list, tag) and pagination. |
get_contact | Read | Fetch detailed information for a specific contact by ID. |
create_or_update_contact | Write | Add or update contact data using email as a unique identifier. |
update_contact | Write | Update an existing contact's details and custom field values. Only the fields provided are changed. |
bulk_import_contacts | Write | Create or update 10 or more contacts in one request, including tags, field values, and list subscriptions. |
get_top_contacts | Read | Retrieve the most active contacts, ranked by cumulative activity. |
get_contact_score_values | Read | Retrieve a contact's score under each scoring rule. |
list_contact_activities | Read | View a chronological log of a contact's activity: email interactions, subscriptions, automation steps, deal tasks, SMS, link clicks, and eCommerce orders. |
bulk_import_status_list | Read | Check the status of bulk contact imports, both in progress and recently completed. |
Tags
Search tags, see which tags a contact has, and apply tags to contacts.
| Tool | Type | Description |
|---|---|---|
list_tags | Read | Search and filter tags by name with various matching operators. |
get_tag | Read | Fetch metadata for a specific tag. |
get_contact_tags | Read | Retrieve all tags applied to a contact, looked up by contact ID or email. |
create_contact_tag | Write | Create a new organizational tag. |
add_tag_to_contact | Write | Apply a specific tag to a contact record. |
Lists
Browse and manage lists and contacts' list subscriptions.
| Tool | Type | Description |
|---|---|---|
list_lists | Read | Browse and search available contact lists. |
get_list | Read | Retrieve configuration and tracking options for a list. |
get_contact_list_memberships | Read | Retrieve every list a contact belongs to. |
create_list | Write | Establish a new contact list for email or SMS. |
update_list | Write | Update existing list settings (name, compliance URLs, reminders). |
add_contact_to_list | Write | Manage a contact's subscription status (Active, Unsubscribed, Unconfirmed). |
Custom Fields
Define contact custom fields, their options, and which lists they appear on.
| Tool | Type | Description |
|---|---|---|
list_contact_custom_fields | Read | Retrieve definitions of all contact custom fields. |
get_contact_custom_field | Read | Fetch details for a specific custom field definition. |
create_contact_custom_field | Write | Create a new field (text, date, dropdown, etc.) for contacts. |
create_field_options | Write | Batch create options for selection-based custom fields. |
create_contact_field_relationship | Write | Link a custom field to specific contact lists. |
Field Values
Read and set the custom field values stored on contacts.
| Tool | Type | Description |
|---|---|---|
list_contact_field_values | Read | Retrieve actual data values stored in custom fields across contacts. |
get_contact_field_value | Read | Fetch a specific data point for a contact field. |
get_contact_field_values | Read | Retrieve all custom field values for a single contact. |
create_contact_field_value | Write | Set or create a value for a specific contact's custom field. |
update_contact_field_value | Write | Modify an existing custom field value. |
Campaigns
Find campaigns and read their details and tracked links.
| Tool | Type | Description |
|---|---|---|
list_campaigns | Read | Retrieve campaigns with filters for status, type, and dates. |
get_campaign | Read | Fetch full details for a single campaign. |
get_campaign_links | Read | Get all tracked links associated with a campaign. |
update_campaign | Write | Rename an existing campaign. |
Campaign Reporting
Measure campaign performance: sends, opens, clicks, bounces, unsubscribes, and email clients.
| Tool | Type | Description |
|---|---|---|
run_campaign_performance_report | Read | Report on campaign performance (sends, opens, clicks, bounces, unsubscribes, and their rates), and rank or compare campaigns. Also covers geography, clicked links, and per-subscriber engagement. |
get_campaign_email_clients | Read | Break down which email clients a campaign's recipients used to open or view it. |
Campaign Creation & Editing
Create, revise, copy, and import email campaigns with AI. These tools run in the background, so you check on progress with the polling and run tools.
| Tool | Type | Description |
|---|---|---|
generate_campaign | Write | Create a new AI-generated email campaign from a text prompt, optionally based on a template, a past campaign, or a web page. |
edit_campaign | Write | Revise an existing campaign's content, images, subject line, or preheader from a plain-language instruction. |
copy_campaign | Write | Duplicate an existing campaign as a new draft, with optional changes applied to the copy. |
import_campaign_design | Write | Import an existing HTML email as a new draft campaign, keeping its content and design as-is. |
get_campaign_generation_context | Read | Gather recent campaigns and list audiences as background context for writing or editing a campaign. |
poll_campaign_generation_status | Read | Track the progress and final outcome of a campaign generate, edit, copy, or import run. |
list_campaign_runs | Read | List recent campaign generate, edit, copy, and import runs, newest first. |
cancel_campaign_run | Write | Stop a campaign generation run that is still in progress. |
Campaign Versions
Review a campaign's change history and undo or redo changes.
| Tool | Type | Description |
|---|---|---|
get_campaign_history | Read | View a campaign's change history, or compare two versions. |
restore_campaign_version | Write | Undo the latest change to a campaign, or revert it to an earlier version. |
redo_campaign_version | Write | Reapply a change that was undone, or move forward to a later version. |
Campaign Templates
Find, save, and manage reusable campaign templates.
| Tool | Type | Description |
|---|---|---|
list_campaign_templates | Read | Search or list the account's saved campaign templates. |
save_campaign_as_template | Write | Save an existing campaign to the template library for reuse. |
manage_campaign_template | Write | Rename, duplicate, or delete a saved template. |
Campaign Sending & Scheduling
Send or schedule a campaign in two steps: a prepare tool checks the campaign and returns a summary, and the matching confirm tool runs only after the user approves it.
| Tool | Type | Description |
|---|---|---|
prepare_campaign_send | Write | Run pre-send checks on a one-time or A/B campaign and return a summary to confirm. Never sends anything on its own. |
confirm_campaign_send | Write | Send a prepared campaign immediately, after the user explicitly approves its summary. |
prepare_campaign_schedule | Write | Check that a campaign can be scheduled for a future time (with optional predictive sending) and return a summary to confirm. |
confirm_campaign_schedule | Write | Schedule a prepared campaign, after the user explicitly approves its summary. |
unschedule_campaign | Write | Cancel a campaign's scheduled send and return it to draft. |
Campaign Message Details
Read and update a campaign's message content, subject line, preheader, and sender.
| Tool | Type | Description |
|---|---|---|
get_campaign_messages | Read | Retrieve a campaign's message content, including HTML body, subject, and preheader. |
get_campaign_editor_markup | Read | Retrieve a campaign message's editor HTML and CSS for previews that keep responsive styles. |
update_campaign_message | Write | Update message content, including HTML, subject line, preheader, and sender info. |
Automations
List automations and manage which contacts are enrolled in them.
| Tool | Type | Description |
|---|---|---|
list_automations | Read | List all automation workflows and their statuses. |
list_contact_automations | Read | Check a contact's progress or enrollment in various automations. |
get_contact_automation | Read | Details of a contact's specific journey through an automation. |
add_contact_to_automation | Write | Manually trigger an automation for a contact. |
remove_contact_from_automation | Write | Eject a contact from an active automation workflow. |
Automation Builder
Build and change automations from a plain-language description. Builds run in the background, so you check on progress with the polling and run tools.
| Tool | Type | Description |
|---|---|---|
generate_automation | Write | Build a new automation from a plain-language description of its trigger, steps, and emails. |
edit_automation | Write | Change an existing automation from a plain-language description of the change. |
poll_automation_generation_status | Read | Track the progress and final outcome of an automation build or edit. |
list_automation_runs | Read | List recent automation build and edit runs, newest first. |
cancel_automation_run | Write | Stop an automation build or edit that is still in progress. |
Deals (CRM)
Find, create, and update deals and their notes.
| Tool | Type | Description |
|---|---|---|
list_deals | Read | Filter and list sales opportunities by stage, status, value, and owner. |
get_deal | Read | Fetch the full record for a specific sales opportunity. |
create_deal | Write | Create a new deal associated with a contact or account. |
update_deal | Write | Update deal attributes like value, title, stage, or status. |
create_deal_note | Write | Add a text note to a specific deal. |
update_deal_note | Write | Edit an existing note on a deal. |
deal_owner_bulk_update | Write | Reassign multiple deals to new owners in a single batch. |
Pipelines & Stages
Manage sales pipelines and the stages deals move through.
| Tool | Type | Description |
|---|---|---|
list_deal_pipelines | Read | View all sales pipelines (deal groups) available in the account. |
get_deal_pipeline | Read | Retrieve stages and configuration for a specific pipeline. |
create_deal_pipeline | Write | Configure a new sales process with currency and assignment rules. |
update_deal_pipeline | Write | Modify pipeline auto-assignment and access permissions. |
list_deal_stages | Read | List deal stages, optionally filtered to a single pipeline. |
get_deal_stage | Read | Retrieve a single deal stage by ID. |
create_deal_stage | Write | Add a new stage to a pipeline. |
update_deal_stage | Write | Update an existing deal stage's settings. |
move_deals_to_stage | Write | Move every deal in one stage to another stage in the same pipeline. |
Activities
Retrieve the history of deal activity and email engagement.
| Tool | Type | Description |
|---|---|---|
list_deal_activities | Read | Retrieve history of actions taken on deals. |
list_email_activities | Read | Retrieve contact engagement (opens, clicks) across campaigns. |
Groups
Manage user groups and their access to lists.
| Tool | Type | Description |
|---|---|---|
list_groups | Read | Retrieve user groups for list permission management. |
create_list_group_permission | Write | Grant list visibility to specific user groups. |
Custom Objects
Define custom object schemas and read their records.
| Tool | Type | Endpoint | Description |
|---|---|---|---|
catalog_list-all-schemas | Read | GET /customObjects/schemas | View custom object types / list all schemas. |
catalog_retrieve-a-schema | Read | GET /customObjects/schemas/{id} | Fetch the definition of a single custom object schema. |
catalog_create-a-schema | Write | POST /customObjects/schemas | Define a new custom object schema. |
catalog_create-a-public-schema | Write | POST /customObjects/schemas/public | Define a new public custom object schema. |
catalog_create-a-child-schema | Write | POST /customObjects/schemas/{id}/child | Create a child schema based on an existing schema. |
catalog_list-records-created-from-a-schema | Read | GET /customObjects/records/{schemaId} | View records created from a schema. |
catalog_get-a-single-record | Read | GET /customObjects/records/{schemaId}/{recordId} | Fetch a single custom object record by ID. |
catalog_get-a-single-record-using-external-id | Read | GET /customObjects/records/{schemaId}/external/{externalId} | Fetch a single custom object record by its external ID. |
API Catalog Tools
Each catalog_ tool performs one ActiveCampaign v3 API operation, shown in the Endpoint column, and accepts that endpoint's parameters directly. See the API reference for request and response details. Read and create operations are available; update and delete operations are not currently exposed through the catalog.
Contacts & Activity
Contact records, notes, scores, bounce logs, geolocation, and activity history.
| Tool | Type | Endpoint | Description |
|---|---|---|---|
catalog_get-contact | Read | GET /contacts/{id} | Retrieve an existing contact. |
catalog_get-contact-restore-request | Read | GET /contactArchives/restoreRequest/{id} | Retrieve a contact restore. |
catalog_list-all-bounce-logs | Read | GET /bounceLogs | List all bounce logs. |
catalog_list-all-contacts | Read | GET /contacts | List, search, and filter contacts. |
catalog_list-archived-contacts | Read | GET /contactArchives | The archived contacts of the account: contacts that were deleted and are kept for 360 days before they are purged. |
catalog_list-contact-data | Read | GET /contactData | List contact data records. |
catalog_list-contact-restore-requests | Read | GET /contactArchives/restoreRequest | List running contact restores. |
catalog_retrieve-a-contacts-score-value | Read | GET /contacts/{id}/scoreValues | Retrieve a contact's score value. |
catalog_retrieve-archived-contact | Read | GET /contactArchives/{id} | Retrieve an archived contact. |
catalog_retrieve-contact-account-contacts | Read | GET /contacts/{id}/accountContacts | Retrieve a contacts account contacts. |
catalog_retrieve-contact-automation-entry-counts | Read | GET /contacts/{id}/automationEntryCounts | Retrieve a contacts automation entry counts. |
catalog_retrieve-contact-bounce-logs | Read | GET /contacts/{id}/bounceLogs | Retrieve a contact's bounce logs. |
catalog_retrieve-contact-data | Read | GET /contacts/{id}/contactData | Retrieve a contact's data. |
catalog_retrieve-contact-data-record | Read | GET /contactData/{id} | Retrieve a contact data record. |
catalog_retrieve-contact-deals | Read | GET /contacts/{id}/deals | Retrieve a contact's deals. |
catalog_retrieve-contact-deals-list | Read | GET /contacts/{id}/contactDeals | Retrieve a list of contact's deals. |
catalog_retrieve-contact-geo-ips | Read | GET /contacts/{id}/geoIps | Retrieve a contacts list of geo-ips. |
catalog_retrieve-contact-goals | Read | GET /contacts/{id}/contactGoals | Retrieve a contact's goals. |
catalog_retrieve-contact-list-memberships | Read | GET /contacts/{id}/contactLists | Retrieve a contact's list memberships. |
catalog_retrieve-contact-logs | Read | GET /contacts/{id}/contactLogs | Retrieve a contact's logs. |
catalog_retrieve-contact-notes | Read | GET /contacts/{contactId}/notes | Retrieve a contact's notes. |
catalog_retrieve-contact-organization | Read | GET /contacts/{id}/organization | Retrieve a contacts organization. |
catalog_retrieve-contact-plus-append | Read | GET /contacts/{id}/plusAppend | Retrieve a contact's social data. |
catalog_create-a-contact-note | Write | POST /contacts/{contactId}/notes | Create a note on a contact. |
catalog_create-a-new-contact | Write | POST /contacts | Create a brand-new contact. |
catalog_list-all-contact-tags | Read | GET /contactTags | List all contact-tag associations. |
catalog_retrieve-a-contact-tag | Read | GET /contactTags/{id} | Retrieve a contact tag. |
catalog_retrieve-contact-tags | Read | GET /contacts/{id}/contactTags | List the tags applied to a contact. |
catalog_apply-tags-to-a-contact | Write | POST /contacts/{contactId}/tags | Apply tags to a contact. |
catalog_create-contact-tag | Write | POST /contactTags | Add a tag to contact. |
catalog_list-all-contact-list-subscriptions | Read | GET /contactLists | List contact subscriptions to lists. |
catalog_retrieve-a-contact-list-subscription | Read | GET /contactLists/{id} | Retrieve a contact list subscription. |
catalog_list-all-scores | Read | GET /scores | List all scores. |
catalog_retrieve-a-score | Read | GET /scores/{id} | Retrieve a score. |
catalog_list-all-geo-addresses | Read | GET /geoAddresses | List all geo addresses. |
catalog_list-all-geo-ips | Read | GET /geoIps | List all geo IP entries. |
catalog_retrieve-a-contacts-geo-ip-address | Read | GET /geoIps/{id}/geoAddress | Retrieve the location of a geo IP entry. |
catalog_retrieve-a-geo-address | Read | GET /geoAddresses/{id} | Retrieve a geo address. |
catalog_retrieve-a-geo-ip | Read | GET /geoIps/{id} | Retrieve a geo IP entry. |
catalog_list-contact-activities | Read | GET /activities | List a contact's activity history: recent events such as campaign emails sent, link clicks, list and automation changes, notes. |
catalog_list-stats-activity-items | Read | GET /statsActivityItem/get | List recent activity items. |
catalog_retrieve-a-contact-activity | Read | GET /activities/{id} | Retrieve one activity entry. |
catalog_list-all-email-activities | Read | GET /emailActivities | List all email activities. |
catalog_retrieve-a-note | Read | GET /notes/{id} | Returns one note by its id, drafts included. |
catalog_retrieve-list-of-all-notes | Read | GET /notes | Retrieve list of all notes. |
catalog_create-a-note | Write | POST /notes | Create a note on a contact, deal, task, activity, or account. |
Contact Imports
Status, history, and failed rows of contact imports.
| Tool | Type | Endpoint | Description |
|---|---|---|---|
catalog_bulk-import-status-info | Read | GET /import/info | Bulk import status info. |
catalog_bulk-import-status-list | Read | GET /import/bulk_import | Summarize recent API bulk imports by day. |
catalog_list-contact-import-log-rows | Read | GET /contactImports | List contact import log rows. |
catalog_list-import-failed-rows | Read | GET /import/history/{importId}/{type} | List the rows of an app or integration import that failed or were only partly imported, with reasons. |
catalog_list-import-history | Read | GET /import/history | List contact imports made from the app or by integrations. |
catalog_retrieve-a-contact-import-log-row | Read | GET /contactImports/{id} | Retrieve a contact import log row. |
Lists & Tags
Lists, SMS lists, exclusions, tags, and list permissions.
| Tool | Type | Endpoint | Description |
|---|---|---|---|
catalog_exclusions-retrieve-a-list | Read | GET /lists/exclusions | The account's exclusion list: suppression rules that stop sends to matching addresses or numbers even when a contact is active on a list. |
catalog_exclusions-retrieve-an-exclusion | Read | GET /lists/exclusions/{id} | Retrieve one exclusion rule by id. |
catalog_list-all-sms-lists | Read | GET /sms/lists | List SMS broadcast lists. |
catalog_retrieve-a-list | Read | GET /lists/{id} | Retrieve one contact list by id. |
catalog_retrieve-all-lists | Read | GET /lists | Retrieve the account's contact lists, 20 per request by default and at most 100; page with offset. |
catalog_retrieve-list-contact-trends | Read | GET /ai/report_trends_activity | Retrieve contact trends for a list. |
catalog_create-new-list | Write | POST /lists | Create a list. |
catalog_retrieve-a-tag | Read | GET /tags/{id} | Returns a single tag definition, including subscriber_count, the number of contacts the tag is applied to. |
catalog_retrieve-all-tags | Read | GET /tags | Returns tag definitions, each with subscriber_count, the number of contacts the tag is applied to. |
catalog_create-a-new-tag | Write | POST /tags | Creates a tag definition. |
catalog_list-all-list-group-permissions | Read | GET /listGroups | List which user groups can access each list. |
catalog_retrieve-a-list-group-permission | Read | GET /listGroups/{id} | Retrieve a list group permission. |
catalog_create-a-list-group-permission | Write | POST /listGroups | Create a list group permission. |
Custom Fields
Contact and deal custom field definitions, values, options, and field groups.
| Tool | Type | Endpoint | Description |
|---|---|---|---|
catalog_list-all-custom-fields-meta | Read | GET /accountCustomFieldMeta | List account custom fields. |
catalog_list-field-details | Read | GET /fieldDetails | List the required and default-value settings of standard fields. |
catalog_retrieve-a-custom-deal-field-meta | Read | GET /dealCustomFieldMeta/{id} | Retrieve a deal custom field. |
catalog_retrieve-a-custom-field-contact | Read | GET /fields/{id} | Get a custom field by ID. |
catalog_retrieve-a-custom-field-meta | Read | GET /accountCustomFieldMeta/{id} | Retrieve an account custom field. |
catalog_retrieve-all-custom-deal-field-meta | Read | GET /dealCustomFieldMeta | List deal custom fields. |
catalog_retrieve-fields | Read | GET /fields | List contact custom fields. |
catalog_create-a-contact-custom-field | Write | POST /fields | Create a contact custom field. |
catalog_create-a-customfieldmeta | Write | POST /accountCustomFieldMeta | Create an account custom field. |
catalog_create-custom-deal-field-meta | Write | POST /dealCustomFieldMeta | Create a deal custom field. |
catalog_list-all-custom-field-values | Read | GET /fieldValues | List contact custom field values. |
catalog_list-all-custom-field-values-2 | Read | GET /accountCustomFieldData | List account custom field values. |
catalog_list-all-custom-fielddata-field-values | Read | GET /dealCustomFieldData | List deal custom field values. |
catalog_retrieve-a-custom-deal-field-value | Read | GET /dealCustomFieldData/{id} | Retrieve a deal custom field value. |
catalog_retrieve-a-custom-field-value | Read | GET /accountCustomFieldData/{id} | Retrieve an account custom field value. |
catalog_retrieve-a-fieldvalues | Read | GET /fieldValues/{id} | Retrieve a contact custom field value. |
catalog_retrieve-contact-field-values | Read | GET /contacts/{id}/fieldValues | Retrieve a contact's field values. |
catalog_create-a-custom-field-value | Write | POST /accountCustomFieldData | Set an account custom field value. |
catalog_create-custom-deal-field-value | Write | POST /dealCustomFieldData | Set a deal custom field value. |
catalog_list-all-field-options | Read | GET /fieldOptions | List all field options. |
catalog_retrieve-a-field-option | Read | GET /fieldOptions/{id} | Retrieve a field option. |
catalog_create-a-field-option | Write | POST /fieldOptions | Create a field option. |
catalog_list-all-custom-field-relationships | Read | GET /fieldRels | List all custom field relationships to lists. |
catalog_retrieve-a-custom-field-relationship | Read | GET /fieldRels/{fieldRelId} | Retrieve a custom field relationship to lists. |
catalog_create-a-custom-field-relationship-to-lists | Write | POST /fieldRels | Create a custom field relationship to list(s). |
catalog_create-a-custom-field-group | Write | POST /groupDefinitions | Create a custom field group. |
Segments & Audiences
Segments, saved audiences, and checks of whether contacts match a segment.
| Tool | Type | Endpoint | Description |
|---|---|---|---|
catalog_retrieve-a-segment-v2 | Read | GET /segmentsV2/{segmentId} | Retrieve a segment definition (V2). |
catalog_retrieve-a-segment-v2-version | Read | GET /segmentsV2/{segmentId}/createdDate/{timestamp} | Retrieve a historic segment definition (V2). |
catalog_retrieve-segment-metadata | Read | GET /segmentsV2/metadata/{segmentId} | Metadata for one saved segment by its UUID — the record about the segment rather than its condition definition. |
catalog_check-segment-match | Read | GET /segmentMatch/{segmentId}/{contactId} | Check whether a contact matches a segment. |
catalog_check-segment-match-external | Read | GET /segmentMatch/{segmentId}/{contactId}/{externalId} | Check a segment match by external id. |
catalog_get_result_set_by_run_id | Read | GET /segmentMatchSome/{segmentId}/{runId} | Return a Match Some result-set. |
catalog_create_match_all_request | Write | POST /segmentMatchAll | Create a Match All request for a new segment. |
catalog_create_match_all_request_with_segment_id | Write | GET /segmentMatchAll/{segmentId} | Create a Match All request. |
catalog_find_contact_id_by_ac_playload | Write | POST /segmentMatchSome/{segmentId} | Create a Match Some request. |
catalog_get_result_set_by_id | Write | GET /segmentMatchAll/{segmentId}/{runId} | Return Match All result-set. |
catalog_list-all-segments | Read | GET /segments | Records in hosted's legacy segment table. |
catalog_retrieve-a-segment | Read | GET /segments/{id} | One record from hosted's legacy segment table, by integer id. |
catalog_list-all-audiences | Read | GET /audiences | List all saved audience segments. |
catalog_retrieve-an-audience | Read | GET /audiences/{segmentId} | Retrieve a saved audience segment. |
Campaigns & Messages
Campaigns, messages, email templates, and personalization variables.
| Tool | Type | Endpoint | Description |
|---|---|---|---|
catalog_list-all-campaigns | Read | GET /campaigns | List all campaigns. |
catalog_retrieve-a-campaign | Read | GET /campaigns/{id} | Retrieve a campaign. |
catalog_retrieve-links-associated-campaign | Read | GET /campaigns/{id}/links | Retrieve links associated to campaign. |
catalog_create-campaign | Write | POST /campaign | Create campaign. |
catalog_duplicate-campaign | Write | POST /campaigns/{id}/copy | Duplicate campaign. |
catalog_preview-a-campaign-message | Write | POST /campaigns/test-preview | Preview a campaign message. |
catalog_retrieve-campaign-messages-associated-campaign | Read | GET /campaigns/{id}/campaignMessages | Retrieve campaign messages associated to campaign. |
catalog_create-a-campaign-message | Write | POST /campaignMessages | Create a campaign message. |
catalog_list-all-messages | Read | GET /messages | List all messages. |
catalog_retrieve-a-campaign-message-source | Read | GET /message/source | Retrieve the source of a campaign message. |
catalog_retrieve-a-message | Read | GET /messages/{id} | Retrieve a message. |
catalog_create-a-new-message | Write | POST /messages | Create a message. |
catalog_list-all-templates | Read | GET /templates | Retrieve the email templates in the account. |
catalog_retrieve-a-template | Read | GET /templates/{id} | Retrieve a template. |
catalog_create-a-template | Write | POST /templates | Create an email template. |
catalog_list-all-personalization-tags | Read | GET /persTags | List all personalization tags. |
catalog_list-variables | Read | GET /personalizations | Retrieve a list of personalization variables. |
catalog_personalization-tags | Read | GET /stripo/personalizationTags | Personalization tags. |
catalog_retrieve-variable | Read | GET /personalizations/{variableId} | Retrieve an individual personalization variable. |
catalog_create-variable | Write | POST /personalizations | Create a personalization variable. |
catalog_get-editor-markup | Read | GET /content/editorMarkup/{messageId} | Get editor markup. |
Brand Kits & Content Manager
Brand kits, branding settings, and Content Manager files and folders.
| Tool | Type | Endpoint | Description |
|---|---|---|---|
catalog_list-all-brand-kits | Read | GET /ai/brand | List all brand kits. |
catalog_retrieve-a-brand-kit | Read | GET /ai/brand/{uuid} | Retrieve a brand kit. |
catalog_retrieve-brand-kit-competitors | Read | GET /ai/brand/{uuid}/competitors | Retrieve a brand kit's competitors. |
catalog_retrieve-brand-kit-tone | Read | GET /ai/brand/{uuid}/tone | Retrieve a brand kit's tone. |
catalog_retrieve-primary-brand-kit | Read | GET /ai/brand/primary | Retrieve the default (primary) brand kit. |
catalog_create-a-brand-kit | Write | POST /ai/brand | Create a brand kit. |
catalog_brandings | Read | GET /brandings | List the account's branding and white-label settings: site name, logo, favicon, header and footer content, admin template. |
catalog_get-branding | Read | GET /brandings/{id} | Retrieve one branding record by id: site name, logo, favicon, header and footer content, admin template — the account's white-label settings. |
catalog_list-content-manager-file-keywords | Read | GET /content-proxy/files/{id}/tags | List the keywords on a Content Manager file. |
catalog_list-content-manager-folder-files | Read | GET /content-proxy/folders/{id}/files | List the files in a Content Manager folder. |
catalog_list-content-manager-keyword-files | Read | GET /content-proxy/tags/{id}/files | List the files with a keyword. |
catalog_retrieve-a-content-manager-file | Read | GET /content-proxy/files/{id} | Retrieve a content manager file. |
catalog_search-content-manager-files | Read | GET /content-proxy/files | Search the content manager for files. |
catalog_list-all-content-manager-folders | Read | GET /content-proxy/folders | List all content manager folders. |
catalog_list-content-manager-file-folders | Read | GET /content-proxy/files/{id}/folders | Show which folders a Content Manager file is in. |
catalog_retrieve-a-content-manager-folder | Read | GET /content-proxy/folders/{id} | Retrieve a content manager folder. |
Automations & Goals
Automations, their triggers and steps, contact enrollments, and goals.
| Tool | Type | Endpoint | Description |
|---|---|---|---|
catalog_list-all-automations | Read | GET /automations | List automations on the account. |
catalog_list-all-goals | Read | GET /goals | List all goals. |
catalog_list-automation-stats-activity-items | Read | GET /statsActivityItem/get_series | List recent automation entries. |
catalog_retrieve-a-goal | Read | GET /goals/{id} | Retrieve a goal. |
catalog_retrieve-an-automation | Read | GET /automations/{id} | Returns one automation's metadata (name, status, id). |
catalog_retrieve-automation-blocks | Read | GET /automations/{id}/blocks | Retrieve an automation's blocks. |
catalog_retrieve-automation-triggers | Read | GET /automations/{id}/triggers | Retrieve how contacts enter an automation (its start triggers). |
catalog_retrieve-goal-showcase | Read | GET /goal/showcase | How many contacts entered the goal's automation, plus the top ten tags, top ten lists and time-to-goal buckets among contacts who reached the goal. |
catalog_retrieve-goal-stats | Read | GET /goal/goalStats | Completion statistics for one automation goal, ranked against the other goals in the same automation. |
catalog_build-an-automation | Write | POST /ai/automations/build | Save an automation from a drafted schema. |
catalog_generate-an-automation-schema | Write | POST /ai/automations/schema | Draft an automation from a prompt. |
catalog_list-all-contact-automations | Read | GET /contactAutomations | List all automations a contact is in. |
catalog_list-all-contactautomations-for-automation | Read | GET /automations/{seriesId}/contactAutomations | List all contacts in an automation. |
catalog_list-all-contactautomations-for-contact | Read | GET /contacts/{id}/contactAutomations | List all automations the contact is in. |
catalog_retrieve-a-contactautomation | Read | GET /contactAutomations/{id} | Retrieve an automation a contact is in. |
catalog_retrieve-contact-automation-steps | Read | GET /automations/{seriesId}/contactAutomations/{contactAutomationId}/steps | Retrieve one contact's recorded steps and skip reason in an automation. |
catalog_create-new-contactautomation | Write | POST /contactAutomations | Add a contact to an automation. |
catalog_list-business-goals | Read | GET /businessGoals/data | List business goals (agent-oriented read). |
catalog_retrieve-a-business-goal | Read | GET /initiatives/{initiativeId} | Retrieve a business goal. |
catalog_retrieve-business-goal-data | Read | GET /businessGoals/data/{initiativeId} | Retrieve a business goal (agent-oriented read). |
catalog_build-a-business-goal | Write | POST /initiatives/buildbusinessgoal | Build a business goal from a schema. |
Conversions
Conversions, conversion labels, and their metrics and trends.
| Tool | Type | Endpoint | Description |
|---|---|---|---|
catalog_list-conversion-metrics | Read | GET /conversions/metrics | Agent-oriented read: event count, unique contacts, and total value per conversion. |
catalog_list-conversions | Read | GET /conversions | List conversions. |
catalog_list-conversions-data | Read | GET /conversions/data | Read-optimized conversion stats (counts, values, graph series), separate from GET /conversions. |
catalog_retrieve-a-conversion | Read | GET /conversions/{id} | Retrieve a conversion. |
catalog_retrieve-a-conversions-data | Read | GET /conversions/{id}/data | Retrieve a conversion's statistics. |
catalog_retrieve-a-conversions-metrics | Read | GET /conversions/{id}/metrics | Retrieve a conversion's metrics. |
catalog_retrieve-a-conversions-trends | Read | GET /conversions/{id}/trends | Retrieve a conversion's daily trend data. |
catalog_create-a-conversion | Write | POST /conversions | Create a conversion. |
catalog_list-conversion-labels | Read | GET /conversions/labels | A 'conversion label' (ConversionFolder) is the association row between a conversion and a label/folder -- not the label itself. |
catalog_retrieve-a-conversion-label | Read | GET /conversions/labels/{id} | Retrieve a conversion label. |
catalog_create-a-conversion-label | Write | POST /conversions/labels | Create a conversion label. |
Deals & CRM
Deals, pipelines, stages, roles, tasks, task types, and saved responses.
| Tool | Type | Endpoint | Description |
|---|---|---|---|
catalog_list-all-deals | Read | GET /deals | Retrieve all existing deals. |
catalog_retrieve-a-deal | Read | GET /deals/{id} | One deal by its id: its title, value and currency, the pipeline (group) and stage it is in, its owner, its primary contact and account, and its status (0 open, 1 won, 2 lost). |
catalog_create-a-deal-new | Write | POST /deals | Create a new deal. |
catalog_create-a-deal-note | Write | POST /deals/{id}/notes | Create a deal note. |
catalog_list-all-secondary-contacts | Read | GET /contactDeals | List all secondary contacts. |
catalog_retrieve-a-secondary-contact | Read | GET /contactDeals/{id} | Retrieve a secondary contact. |
catalog_create-a-secondary-contact | Write | POST /contactDeals | Create a secondary contact. |
catalog_list-all-deal-activities | Read | GET /dealActivities | List all deal activities. |
catalog_retrieve-inaccessible-pipelines-by-user | Read | GET /dealGroup/get_inaccessible_deal_groups | Retrieve inaccessible pipelines by user. |
catalog_list-all-pipelines | Read | GET /dealGroups | Retrieve all existing pipelines. |
catalog_retrieve-a-pipeline | Read | GET /dealGroups/{id} | Retrieve an existing pipeline. |
catalog_create-a-pipeline | Write | POST /dealGroups | Create a new pipeline. |
catalog_list-all-deal-stages | Read | GET /dealStages | Retrieve all existing stages. |
catalog_retrieve-a-deal-stage | Read | GET /dealStages/{id} | Retrieve an existing stage. |
catalog_create-a-deal-stage | Write | POST /dealStages | Create a new stage for a pipeline. |
catalog_list-all-deal-roles | Read | GET /dealRoles | List all deal roles. |
catalog_create-a-deal-role | Write | POST /dealRoles | Create a deal role. |
catalog_list-all-deal-task-types | Read | GET /dealTasktypes | List all task types. |
catalog_retrieve-a-deal-task-type | Read | GET /dealTasktypes/{id} | Retrieve a task type. |
catalog_create-a-deal-task-type | Write | POST /dealTasktypes | Create a task type. |
catalog_get-task | Read | GET /dealTasks/{id} | Retrieve an existing task. |
catalog_list-all-tasks | Read | GET /dealTasks | Retrieve a list of existing tasks. |
catalog_create-task | Write | POST /dealTasks | Create a new task. |
catalog_list-all-task-notifications | Read | GET /taskNotifications | List deal task notification settings. |
catalog_create-a-task-reminder | Write | POST /taskNotifications | Create a task reminder. |
catalog_list-all-task-outcomes | Read | GET /taskOutcomes | List all task outcomes. |
catalog_retrieve-a-task-outcome | Read | GET /taskOutcomes/{id} | Retrieve a task outcome. |
catalog_create-a-task-outcome | Write | POST /taskOutcomes | Create a task outcome. |
catalog_list-all-task-type-outcome-relations | Read | GET /tasktypeOutcomeRels | List all task type - outcome relations. |
catalog_retrieve-a-task-type-outcome-relation | Read | GET /tasktypeOutcomeRels/{id} | Retrieve a task type - outcome relation. |
catalog_create-a-task-outcome-1 | Write | POST /tasktypeOutcomeRels | Assign a task outcome to a task type. |
catalog_get-a-savedresponse | Read | GET /savedResponses/{id} | Retrieve a saved response. |
catalog_list-all-saved-responses | Read | GET /savedResponses | List all saved responses. |
catalog_saved-responses | Write | POST /savedResponses | Create a saved response. |
catalog_list-all-calendar-feeds | Read | GET /calendars | List all calendar feeds. |
catalog_list-all-calendar-feeds-1 | Read | GET /calendars/{id} | Retrieve a calendar feed. |
catalog_create-a-calendar-feed | Write | POST /calendars | Create a calendar feed. |
Accounts (CRM)
CRM accounts, their notes, and the contacts linked to them.
| Tool | Type | Endpoint | Description |
|---|---|---|---|
catalog_list-all-accounts | Read | GET /accounts | Retrieve all existing account. |
catalog_retrieve-an-account | Read | GET /accounts/{id} | Retrieve an existing account. |
catalog_create-an-account-new | Write | POST /accounts | Create a new account. |
catalog_create-an-account-note | Write | POST /accounts/{id}/notes | Create an account note. |
catalog_list-all-associations-1 | Read | GET /accountContacts | Lists links between contacts and accounts. |
catalog_retrieve-an-association | Read | GET /accountContacts/{id} | Returns one link between a contact and an account. |
catalog_create-an-account-1 | Write | POST /accountContacts | Links a contact to an account, optionally with the contact's job title there. |
eCommerce
eCommerce connections, customers, orders, order products, and sales summaries.
| Tool | Type | Endpoint | Description |
|---|---|---|---|
catalog_get-customer | Read | GET /ecomCustomers/{id} | Retrieve an existing e-commerce customer resource. |
catalog_list-all-customers | Read | GET /ecomCustomers | List all e-commerce customer resources. |
catalog_retrieve-ecom-customer-behavior-summary | Read | GET /ai/ecom/customerBehaviorSummary | Retrieve an ecommerce customer behavior summary. |
catalog_create-customer | Write | POST /ecomCustomers | Create a new e-commerce customer resource. |
catalog_get-order | Read | GET /ecomOrders/{ecomOrderId} | Retrieve an existing e-commerce order resource. |
catalog_list-all-orders | Read | GET /ecomOrders | List all existing e-commerce order resources. |
catalog_list-products-for-order | Read | GET /ecomOrders/{id}/orderProducts | List ecomorderproducts for a specific ecomorder. |
catalog_retrieve-ecom-order-status-summary | Read | GET /ai/ecom/orderStatusSummary | Retrieve an ecommerce order status summary. |
catalog_retrieve-ecom-revenue-summary | Read | GET /ai/ecom/revenueSummary | Retrieve an ecommerce revenue summary. |
catalog_create-order | Write | POST /ecomOrders | Create a new e-commerce order resource. |
catalog_list-ecomorderproducts | Read | GET /ecomOrderProducts | List ecomorderproducts. |
catalog_retrieve-an-ecomorderproduct | Read | GET /ecomOrderProducts/{id} | Retrieve an ecomorderproduct. |
catalog_retrieve-ecom-product-rankings | Read | GET /ai/ecom/productRankings | Retrieve ranked ecommerce products. |
catalog_get-connection | Read | GET /connections/{id} | Retrieve an existing connection resource. |
catalog_list-all-connections | Read | GET /connections | List all existing connection resources. |
catalog_create-connection | Write | POST /connections | Create a new connection resource. |
SMS & WhatsApp
SMS broadcasts, SMS credits, and WhatsApp templates, messages, and flows.
| Tool | Type | Endpoint | Description |
|---|---|---|---|
catalog_getAIBroadcastStatus | Read | GET /sms/broadcasts/ai/{Id} | Get AI broadcast request status. |
catalog_getBroadcast | Read | GET /sms/broadcasts/{id} | Retrieves the full details for one broadcast message. |
catalog_list-sms-broadcast-failures | Read | GET /sms/broadcasts/metrics/{broadcastId}/failures | List SMS broadcast delivery failures. |
catalog_list-sms-broadcast-recipients | Read | GET /sms/broadcasts/{broadcastId}/recipients | List SMS broadcast recipients. |
catalog_listBroadcasts | Read | GET /sms/broadcasts | Get all broadcast messages. |
catalog_retrieve-sms-metrics-snapshot | Read | GET /sms/broadcasts/metrics/snapshot | Retrieve SMS broadcast metrics snapshot. |
catalog_createAIBroadcast | Write | POST /sms/broadcasts/ai | Create broadcast with AI. |
catalog_createBroadcast | Write | POST /sms/broadcasts | Create a new broadcast message. |
catalog_exportBroadcastMetrics | Write | POST /sms/broadcasts/export | Export broadcast performance metrics as CSV. |
catalog_exportBroadcastRecipients | Write | POST /sms/broadcasts/{broadcastId}/recipients/export | Export recipient data as CSV including full contact records. |
catalog_getBroadcastMetrics | Write | POST /sms/broadcasts/metrics | Get all broadcast metrics. |
catalog_getBroadcastSnapshotByIds | Write | POST /sms/broadcasts/metrics/snapshot | Returns snapshot for specified broadcast IDs. |
catalog_get-sms-credits | Read | GET /sms/credits | Retrieve SMS credit balance. |
catalog_get-whatsapp-template | Read | GET /channel/whatsapp/channels/whatsapp/template/{id} | Gets a WhatsApp template by id. |
catalog_list-whatsapp-templates | Read | GET /channel/whatsapp/channels/whatsapp/template | List WhatsApp templates. |
catalog_send-a-whatsapp-template-message | Write | POST /channel/whatsapp/channels/whatsapp/template/{id}/send | Send a WhatsApp template. |
catalog_list-conversations | Read | GET /channel/whatsapp/inbox/conversation | List conversations. |
catalog_get-flow-execution | Read | GET /channel/whatsapp/flow-execution/{id} | Get flow execution by id. |
catalog_get-flow-execution-contact | Read | GET /channel/whatsapp/flow-execution-contact/{id} | Get flow execution contact by id. |
catalog_list-flow-execution | Read | GET /channel/whatsapp/flow-execution | List flow executions. |
catalog_list-flow-execution-contact | Read | GET /channel/whatsapp/flow-execution-contact | List flow execution contacts. |
Site & Event Tracking
Site tracking, tracked domains, and event tracking.
| Tool | Type | Endpoint | Description |
|---|---|---|---|
catalog_retrieve-site-tracking-status | Read | GET /siteTracking | Retrieve whether site tracking is enabled. |
catalog_list-all-tracked-domains | Read | GET /siteTrackingDomains | List all tracked domains. |
catalog_list-all-whitelisted-domains | Read | GET /prism/urlWhitelistings | List all whitelisted domains. |
catalog_add-a-tracked-domain | Write | POST /siteTrackingDomains | Add a tracked domain by name. |
catalog_add-domain-to-whitelist | Write | POST /prism/urlWhitelistings | Add domain to whitelist. |
catalog_retrieve-event-tracking-status | Read | GET /eventTracking | Retrieve event tracking status. |
catalog_list-all-event-types | Read | GET /eventTrackingEvents | List all events (names only). |
catalog_create-a-new-event-name-only | Write | POST /eventTrackingEvents | Create a new event (name only). |
catalog_get-contact-by-event-id | Read | GET /trackingLogs/{eventId}/contact | Look up which contact produced a tracking log entry. |
catalog_list-all-tracked-events | Read | GET /trackingLogs | List the tracked events that have fired, with their contacts. |
catalog_retrieve-a-tracking-log | Read | GET /trackingLogs/{id} | Retrieve a tracking log entry. |
catalog_retrieve-contact-tracking-logs | Read | GET /contacts/{id}/trackingLogs | Retrieve a contacts tracking logs. |
Forms
Forms and their opt-in confirmation emails.
| Tool | Type | Endpoint | Description |
|---|---|---|---|
catalog_forms-1 | Read | GET /forms | List the account's forms with their settings, fields and actions. |
catalog_retrieve-forms | Read | GET /forms/{id} | Retrieve a form's settings, fields and actions. |
catalog_post_formoptin | Write | POST /form/optin | Create a form's opt-in confirmation email. |
catalog_post_forms | Write | POST /forms | Create a form. |
Webhooks
Webhooks and the events they can subscribe to.
| Tool | Type | Endpoint | Description |
|---|---|---|---|
catalog_get-a-list-of-webhooks | Read | GET /webhooks | List all existing webhooks. |
catalog_get-webhook | Read | GET /webhooks/{id} | Retrieve an existing webhook. |
catalog_create-webhook | Write | POST /webhooks | Create a new webhook. |
catalog_get-a-list-of-webhook-events | Read | GET /webhook/events | List the webhook event types available for subscription. |
Account, Users & Permissions
Account information, users, user groups, and mailing addresses.
| Tool | Type | Endpoint | Description |
|---|---|---|---|
catalog_retrieve-account-information | Read | GET /settings/account | Retrieve the hosted account and plan information for the account that owns the API key. |
catalog_get-user | Read | GET /users/{id} | Retrieve an existing user. |
catalog_get-user-email | Read | GET /users/email/{email} | Retrieve a user by email. |
catalog_get-user-loggedin | Read | GET /users/me | Retrieve the logged-in user. |
catalog_get-user-username | Read | GET /users/username/USERNAME | Retrieve a user by username. |
catalog_list-all-users | Read | GET /users | List all existing users. |
catalog_create-user | Write | POST /users | Create a new user with full account access, gated by their group (role). |
catalog_list-all-groups | Read | GET /groups | List all groups. |
catalog_retrieve-a-group | Read | GET /groups/{id} | Retrieve a group. |
catalog_create-a-new-group | Write | POST /groups | Create a group. |
catalog_get-all-custom-field-groups | Read | GET /groupMembers | Get All custom field groups. |
catalog_get-custom-field-to-field-group | Read | GET /groupMembers/{groupId} | Get custom field group by ID. |
catalog_add-custom-field-to-field-group | Write | POST /groupMembers | Add custom field to field group. |
catalog_list-all-group-limits | Read | GET /groupLimits | List All group limits. |
catalog_list-all-addresses | Read | GET /addresses | List all addresses. |
catalog_retrieve-an-address | Read | GET /addresses/{id} | Retrieve an address. |
catalog_create-an-address | Write | POST /addresses | Create a company mailing address for email footers. |
catalog_list-all-address-groups | Read | GET /addressGroups | List which user groups each mailing address belongs to. |
catalog_retrieve-an-addressgroup | Read | GET /addressGroups/{id} | Retrieve an addressGroup. |
catalog_create-an-addressgroup | Write | POST /addressGroups | Associates an address with a group. |
catalog_list-all-address-lists | Read | GET /addressLists | List which lists each mailing address belongs to. |
catalog_retrieve-an-addresslist | Read | GET /addressLists/{id} | Retrieve an addressList. |
catalog_create-an-addresslist | Write | POST /addressLists | Associates an address with a list. |
