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.

ToolTypeDescription
get_profileReadIdentify the ActiveCampaign account connected through the current credentials.
is_phone_only_contacts_enabledReadCheck 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.

ToolTypeDescription
list_contactsReadRetrieve contacts with advanced filtering (segment, form, list, tag) and pagination.
get_contactReadFetch detailed information for a specific contact by ID.
create_or_update_contactWriteAdd or update contact data using email as a unique identifier.
update_contactWriteUpdate an existing contact's details and custom field values. Only the fields provided are changed.
bulk_import_contactsWriteCreate or update 10 or more contacts in one request, including tags, field values, and list subscriptions.
get_top_contactsReadRetrieve the most active contacts, ranked by cumulative activity.
get_contact_score_valuesReadRetrieve a contact's score under each scoring rule.
list_contact_activitiesReadView a chronological log of a contact's activity: email interactions, subscriptions, automation steps, deal tasks, SMS, link clicks, and eCommerce orders.
bulk_import_status_listReadCheck 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.

ToolTypeDescription
list_tagsReadSearch and filter tags by name with various matching operators.
get_tagReadFetch metadata for a specific tag.
get_contact_tagsReadRetrieve all tags applied to a contact, looked up by contact ID or email.
create_contact_tagWriteCreate a new organizational tag.
add_tag_to_contactWriteApply a specific tag to a contact record.

Lists

Browse and manage lists and contacts' list subscriptions.

ToolTypeDescription
list_listsReadBrowse and search available contact lists.
get_listReadRetrieve configuration and tracking options for a list.
get_contact_list_membershipsReadRetrieve every list a contact belongs to.
create_listWriteEstablish a new contact list for email or SMS.
update_listWriteUpdate existing list settings (name, compliance URLs, reminders).
add_contact_to_listWriteManage a contact's subscription status (Active, Unsubscribed, Unconfirmed).

Custom Fields

Define contact custom fields, their options, and which lists they appear on.

ToolTypeDescription
list_contact_custom_fieldsReadRetrieve definitions of all contact custom fields.
get_contact_custom_fieldReadFetch details for a specific custom field definition.
create_contact_custom_fieldWriteCreate a new field (text, date, dropdown, etc.) for contacts.
create_field_optionsWriteBatch create options for selection-based custom fields.
create_contact_field_relationshipWriteLink a custom field to specific contact lists.

Field Values

Read and set the custom field values stored on contacts.

ToolTypeDescription
list_contact_field_valuesReadRetrieve actual data values stored in custom fields across contacts.
get_contact_field_valueReadFetch a specific data point for a contact field.
get_contact_field_valuesReadRetrieve all custom field values for a single contact.
create_contact_field_valueWriteSet or create a value for a specific contact's custom field.
update_contact_field_valueWriteModify an existing custom field value.

Campaigns

Find campaigns and read their details and tracked links.

ToolTypeDescription
list_campaignsReadRetrieve campaigns with filters for status, type, and dates.
get_campaignReadFetch full details for a single campaign.
get_campaign_linksReadGet all tracked links associated with a campaign.
update_campaignWriteRename an existing campaign.

Campaign Reporting

Measure campaign performance: sends, opens, clicks, bounces, unsubscribes, and email clients.

ToolTypeDescription
run_campaign_performance_reportReadReport 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_clientsReadBreak 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.

ToolTypeDescription
generate_campaignWriteCreate a new AI-generated email campaign from a text prompt, optionally based on a template, a past campaign, or a web page.
edit_campaignWriteRevise an existing campaign's content, images, subject line, or preheader from a plain-language instruction.
copy_campaignWriteDuplicate an existing campaign as a new draft, with optional changes applied to the copy.
import_campaign_designWriteImport an existing HTML email as a new draft campaign, keeping its content and design as-is.
get_campaign_generation_contextReadGather recent campaigns and list audiences as background context for writing or editing a campaign.
poll_campaign_generation_statusReadTrack the progress and final outcome of a campaign generate, edit, copy, or import run.
list_campaign_runsReadList recent campaign generate, edit, copy, and import runs, newest first.
cancel_campaign_runWriteStop a campaign generation run that is still in progress.

Campaign Versions

Review a campaign's change history and undo or redo changes.

ToolTypeDescription
get_campaign_historyReadView a campaign's change history, or compare two versions.
restore_campaign_versionWriteUndo the latest change to a campaign, or revert it to an earlier version.
redo_campaign_versionWriteReapply a change that was undone, or move forward to a later version.

Campaign Templates

Find, save, and manage reusable campaign templates.

ToolTypeDescription
list_campaign_templatesReadSearch or list the account's saved campaign templates.
save_campaign_as_templateWriteSave an existing campaign to the template library for reuse.
manage_campaign_templateWriteRename, 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.

ToolTypeDescription
prepare_campaign_sendWriteRun 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_sendWriteSend a prepared campaign immediately, after the user explicitly approves its summary.
prepare_campaign_scheduleWriteCheck that a campaign can be scheduled for a future time (with optional predictive sending) and return a summary to confirm.
confirm_campaign_scheduleWriteSchedule a prepared campaign, after the user explicitly approves its summary.
unschedule_campaignWriteCancel 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.

ToolTypeDescription
get_campaign_messagesReadRetrieve a campaign's message content, including HTML body, subject, and preheader.
get_campaign_editor_markupReadRetrieve a campaign message's editor HTML and CSS for previews that keep responsive styles.
update_campaign_messageWriteUpdate message content, including HTML, subject line, preheader, and sender info.

Automations

List automations and manage which contacts are enrolled in them.

ToolTypeDescription
list_automationsReadList all automation workflows and their statuses.
list_contact_automationsReadCheck a contact's progress or enrollment in various automations.
get_contact_automationReadDetails of a contact's specific journey through an automation.
add_contact_to_automationWriteManually trigger an automation for a contact.
remove_contact_from_automationWriteEject 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.

ToolTypeDescription
generate_automationWriteBuild a new automation from a plain-language description of its trigger, steps, and emails.
edit_automationWriteChange an existing automation from a plain-language description of the change.
poll_automation_generation_statusReadTrack the progress and final outcome of an automation build or edit.
list_automation_runsReadList recent automation build and edit runs, newest first.
cancel_automation_runWriteStop an automation build or edit that is still in progress.

Deals (CRM)

Find, create, and update deals and their notes.

ToolTypeDescription
list_dealsReadFilter and list sales opportunities by stage, status, value, and owner.
get_dealReadFetch the full record for a specific sales opportunity.
create_dealWriteCreate a new deal associated with a contact or account.
update_dealWriteUpdate deal attributes like value, title, stage, or status.
create_deal_noteWriteAdd a text note to a specific deal.
update_deal_noteWriteEdit an existing note on a deal.
deal_owner_bulk_updateWriteReassign multiple deals to new owners in a single batch.

Pipelines & Stages

Manage sales pipelines and the stages deals move through.

ToolTypeDescription
list_deal_pipelinesReadView all sales pipelines (deal groups) available in the account.
get_deal_pipelineReadRetrieve stages and configuration for a specific pipeline.
create_deal_pipelineWriteConfigure a new sales process with currency and assignment rules.
update_deal_pipelineWriteModify pipeline auto-assignment and access permissions.
list_deal_stagesReadList deal stages, optionally filtered to a single pipeline.
get_deal_stageReadRetrieve a single deal stage by ID.
create_deal_stageWriteAdd a new stage to a pipeline.
update_deal_stageWriteUpdate an existing deal stage's settings.
move_deals_to_stageWriteMove every deal in one stage to another stage in the same pipeline.

Activities

Retrieve the history of deal activity and email engagement.

ToolTypeDescription
list_deal_activitiesReadRetrieve history of actions taken on deals.
list_email_activitiesReadRetrieve contact engagement (opens, clicks) across campaigns.

Groups

Manage user groups and their access to lists.

ToolTypeDescription
list_groupsReadRetrieve user groups for list permission management.
create_list_group_permissionWriteGrant list visibility to specific user groups.

Custom Objects

Define custom object schemas and read their records.

ToolTypeEndpointDescription
catalog_list-all-schemasReadGET /customObjects/schemasView custom object types / list all schemas.
catalog_retrieve-a-schemaReadGET /customObjects/schemas/{id}Fetch the definition of a single custom object schema.
catalog_create-a-schemaWritePOST /customObjects/schemasDefine a new custom object schema.
catalog_create-a-public-schemaWritePOST /customObjects/schemas/publicDefine a new public custom object schema.
catalog_create-a-child-schemaWritePOST /customObjects/schemas/{id}/childCreate a child schema based on an existing schema.
catalog_list-records-created-from-a-schemaReadGET /customObjects/records/{schemaId}View records created from a schema.
catalog_get-a-single-recordReadGET /customObjects/records/{schemaId}/{recordId}Fetch a single custom object record by ID.
catalog_get-a-single-record-using-external-idReadGET /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.

ToolTypeEndpointDescription
catalog_get-contactReadGET /contacts/{id}Retrieve an existing contact.
catalog_get-contact-restore-requestReadGET /contactArchives/restoreRequest/{id}Retrieve a contact restore.
catalog_list-all-bounce-logsReadGET /bounceLogsList all bounce logs.
catalog_list-all-contactsReadGET /contactsList, search, and filter contacts.
catalog_list-archived-contactsReadGET /contactArchivesThe archived contacts of the account: contacts that were deleted and are kept for 360 days before they are purged.
catalog_list-contact-dataReadGET /contactDataList contact data records.
catalog_list-contact-restore-requestsReadGET /contactArchives/restoreRequestList running contact restores.
catalog_retrieve-a-contacts-score-valueReadGET /contacts/{id}/scoreValuesRetrieve a contact's score value.
catalog_retrieve-archived-contactReadGET /contactArchives/{id}Retrieve an archived contact.
catalog_retrieve-contact-account-contactsReadGET /contacts/{id}/accountContactsRetrieve a contacts account contacts.
catalog_retrieve-contact-automation-entry-countsReadGET /contacts/{id}/automationEntryCountsRetrieve a contacts automation entry counts.
catalog_retrieve-contact-bounce-logsReadGET /contacts/{id}/bounceLogsRetrieve a contact's bounce logs.
catalog_retrieve-contact-dataReadGET /contacts/{id}/contactDataRetrieve a contact's data.
catalog_retrieve-contact-data-recordReadGET /contactData/{id}Retrieve a contact data record.
catalog_retrieve-contact-dealsReadGET /contacts/{id}/dealsRetrieve a contact's deals.
catalog_retrieve-contact-deals-listReadGET /contacts/{id}/contactDealsRetrieve a list of contact's deals.
catalog_retrieve-contact-geo-ipsReadGET /contacts/{id}/geoIpsRetrieve a contacts list of geo-ips.
catalog_retrieve-contact-goalsReadGET /contacts/{id}/contactGoalsRetrieve a contact's goals.
catalog_retrieve-contact-list-membershipsReadGET /contacts/{id}/contactListsRetrieve a contact's list memberships.
catalog_retrieve-contact-logsReadGET /contacts/{id}/contactLogsRetrieve a contact's logs.
catalog_retrieve-contact-notesReadGET /contacts/{contactId}/notesRetrieve a contact's notes.
catalog_retrieve-contact-organizationReadGET /contacts/{id}/organizationRetrieve a contacts organization.
catalog_retrieve-contact-plus-appendReadGET /contacts/{id}/plusAppendRetrieve a contact's social data.
catalog_create-a-contact-noteWritePOST /contacts/{contactId}/notesCreate a note on a contact.
catalog_create-a-new-contactWritePOST /contactsCreate a brand-new contact.
catalog_list-all-contact-tagsReadGET /contactTagsList all contact-tag associations.
catalog_retrieve-a-contact-tagReadGET /contactTags/{id}Retrieve a contact tag.
catalog_retrieve-contact-tagsReadGET /contacts/{id}/contactTagsList the tags applied to a contact.
catalog_apply-tags-to-a-contactWritePOST /contacts/{contactId}/tagsApply tags to a contact.
catalog_create-contact-tagWritePOST /contactTagsAdd a tag to contact.
catalog_list-all-contact-list-subscriptionsReadGET /contactListsList contact subscriptions to lists.
catalog_retrieve-a-contact-list-subscriptionReadGET /contactLists/{id}Retrieve a contact list subscription.
catalog_list-all-scoresReadGET /scoresList all scores.
catalog_retrieve-a-scoreReadGET /scores/{id}Retrieve a score.
catalog_list-all-geo-addressesReadGET /geoAddressesList all geo addresses.
catalog_list-all-geo-ipsReadGET /geoIpsList all geo IP entries.
catalog_retrieve-a-contacts-geo-ip-addressReadGET /geoIps/{id}/geoAddressRetrieve the location of a geo IP entry.
catalog_retrieve-a-geo-addressReadGET /geoAddresses/{id}Retrieve a geo address.
catalog_retrieve-a-geo-ipReadGET /geoIps/{id}Retrieve a geo IP entry.
catalog_list-contact-activitiesReadGET /activitiesList a contact's activity history: recent events such as campaign emails sent, link clicks, list and automation changes, notes.
catalog_list-stats-activity-itemsReadGET /statsActivityItem/getList recent activity items.
catalog_retrieve-a-contact-activityReadGET /activities/{id}Retrieve one activity entry.
catalog_list-all-email-activitiesReadGET /emailActivitiesList all email activities.
catalog_retrieve-a-noteReadGET /notes/{id}Returns one note by its id, drafts included.
catalog_retrieve-list-of-all-notesReadGET /notesRetrieve list of all notes.
catalog_create-a-noteWritePOST /notesCreate a note on a contact, deal, task, activity, or account.

Contact Imports

Status, history, and failed rows of contact imports.

ToolTypeEndpointDescription
catalog_bulk-import-status-infoReadGET /import/infoBulk import status info.
catalog_bulk-import-status-listReadGET /import/bulk_importSummarize recent API bulk imports by day.
catalog_list-contact-import-log-rowsReadGET /contactImportsList contact import log rows.
catalog_list-import-failed-rowsReadGET /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-historyReadGET /import/historyList contact imports made from the app or by integrations.
catalog_retrieve-a-contact-import-log-rowReadGET /contactImports/{id}Retrieve a contact import log row.

Lists & Tags

Lists, SMS lists, exclusions, tags, and list permissions.

ToolTypeEndpointDescription
catalog_exclusions-retrieve-a-listReadGET /lists/exclusionsThe 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-exclusionReadGET /lists/exclusions/{id}Retrieve one exclusion rule by id.
catalog_list-all-sms-listsReadGET /sms/listsList SMS broadcast lists.
catalog_retrieve-a-listReadGET /lists/{id}Retrieve one contact list by id.
catalog_retrieve-all-listsReadGET /listsRetrieve the account's contact lists, 20 per request by default and at most 100; page with offset.
catalog_retrieve-list-contact-trendsReadGET /ai/report_trends_activityRetrieve contact trends for a list.
catalog_create-new-listWritePOST /listsCreate a list.
catalog_retrieve-a-tagReadGET /tags/{id}Returns a single tag definition, including subscriber_count, the number of contacts the tag is applied to.
catalog_retrieve-all-tagsReadGET /tagsReturns tag definitions, each with subscriber_count, the number of contacts the tag is applied to.
catalog_create-a-new-tagWritePOST /tagsCreates a tag definition.
catalog_list-all-list-group-permissionsReadGET /listGroupsList which user groups can access each list.
catalog_retrieve-a-list-group-permissionReadGET /listGroups/{id}Retrieve a list group permission.
catalog_create-a-list-group-permissionWritePOST /listGroupsCreate a list group permission.

Custom Fields

Contact and deal custom field definitions, values, options, and field groups.

ToolTypeEndpointDescription
catalog_list-all-custom-fields-metaReadGET /accountCustomFieldMetaList account custom fields.
catalog_list-field-detailsReadGET /fieldDetailsList the required and default-value settings of standard fields.
catalog_retrieve-a-custom-deal-field-metaReadGET /dealCustomFieldMeta/{id}Retrieve a deal custom field.
catalog_retrieve-a-custom-field-contactReadGET /fields/{id}Get a custom field by ID.
catalog_retrieve-a-custom-field-metaReadGET /accountCustomFieldMeta/{id}Retrieve an account custom field.
catalog_retrieve-all-custom-deal-field-metaReadGET /dealCustomFieldMetaList deal custom fields.
catalog_retrieve-fieldsReadGET /fieldsList contact custom fields.
catalog_create-a-contact-custom-fieldWritePOST /fieldsCreate a contact custom field.
catalog_create-a-customfieldmetaWritePOST /accountCustomFieldMetaCreate an account custom field.
catalog_create-custom-deal-field-metaWritePOST /dealCustomFieldMetaCreate a deal custom field.
catalog_list-all-custom-field-valuesReadGET /fieldValuesList contact custom field values.
catalog_list-all-custom-field-values-2ReadGET /accountCustomFieldDataList account custom field values.
catalog_list-all-custom-fielddata-field-valuesReadGET /dealCustomFieldDataList deal custom field values.
catalog_retrieve-a-custom-deal-field-valueReadGET /dealCustomFieldData/{id}Retrieve a deal custom field value.
catalog_retrieve-a-custom-field-valueReadGET /accountCustomFieldData/{id}Retrieve an account custom field value.
catalog_retrieve-a-fieldvaluesReadGET /fieldValues/{id}Retrieve a contact custom field value.
catalog_retrieve-contact-field-valuesReadGET /contacts/{id}/fieldValuesRetrieve a contact's field values.
catalog_create-a-custom-field-valueWritePOST /accountCustomFieldDataSet an account custom field value.
catalog_create-custom-deal-field-valueWritePOST /dealCustomFieldDataSet a deal custom field value.
catalog_list-all-field-optionsReadGET /fieldOptionsList all field options.
catalog_retrieve-a-field-optionReadGET /fieldOptions/{id}Retrieve a field option.
catalog_create-a-field-optionWritePOST /fieldOptionsCreate a field option.
catalog_list-all-custom-field-relationshipsReadGET /fieldRelsList all custom field relationships to lists.
catalog_retrieve-a-custom-field-relationshipReadGET /fieldRels/{fieldRelId}Retrieve a custom field relationship to lists.
catalog_create-a-custom-field-relationship-to-listsWritePOST /fieldRelsCreate a custom field relationship to list(s).
catalog_create-a-custom-field-groupWritePOST /groupDefinitionsCreate a custom field group.

Segments & Audiences

Segments, saved audiences, and checks of whether contacts match a segment.

ToolTypeEndpointDescription
catalog_retrieve-a-segment-v2ReadGET /segmentsV2/{segmentId}Retrieve a segment definition (V2).
catalog_retrieve-a-segment-v2-versionReadGET /segmentsV2/{segmentId}/createdDate/{timestamp}Retrieve a historic segment definition (V2).
catalog_retrieve-segment-metadataReadGET /segmentsV2/metadata/{segmentId}Metadata for one saved segment by its UUID — the record about the segment rather than its condition definition.
catalog_check-segment-matchReadGET /segmentMatch/{segmentId}/{contactId}Check whether a contact matches a segment.
catalog_check-segment-match-externalReadGET /segmentMatch/{segmentId}/{contactId}/{externalId}Check a segment match by external id.
catalog_get_result_set_by_run_idReadGET /segmentMatchSome/{segmentId}/{runId}Return a Match Some result-set.
catalog_create_match_all_requestWritePOST /segmentMatchAllCreate a Match All request for a new segment.
catalog_create_match_all_request_with_segment_idWriteGET /segmentMatchAll/{segmentId}Create a Match All request.
catalog_find_contact_id_by_ac_playloadWritePOST /segmentMatchSome/{segmentId}Create a Match Some request.
catalog_get_result_set_by_idWriteGET /segmentMatchAll/{segmentId}/{runId}Return Match All result-set.
catalog_list-all-segmentsReadGET /segmentsRecords in hosted's legacy segment table.
catalog_retrieve-a-segmentReadGET /segments/{id}One record from hosted's legacy segment table, by integer id.
catalog_list-all-audiencesReadGET /audiencesList all saved audience segments.
catalog_retrieve-an-audienceReadGET /audiences/{segmentId}Retrieve a saved audience segment.

Campaigns & Messages

Campaigns, messages, email templates, and personalization variables.

ToolTypeEndpointDescription
catalog_list-all-campaignsReadGET /campaignsList all campaigns.
catalog_retrieve-a-campaignReadGET /campaigns/{id}Retrieve a campaign.
catalog_retrieve-links-associated-campaignReadGET /campaigns/{id}/linksRetrieve links associated to campaign.
catalog_create-campaignWritePOST /campaignCreate campaign.
catalog_duplicate-campaignWritePOST /campaigns/{id}/copyDuplicate campaign.
catalog_preview-a-campaign-messageWritePOST /campaigns/test-previewPreview a campaign message.
catalog_retrieve-campaign-messages-associated-campaignReadGET /campaigns/{id}/campaignMessagesRetrieve campaign messages associated to campaign.
catalog_create-a-campaign-messageWritePOST /campaignMessagesCreate a campaign message.
catalog_list-all-messagesReadGET /messagesList all messages.
catalog_retrieve-a-campaign-message-sourceReadGET /message/sourceRetrieve the source of a campaign message.
catalog_retrieve-a-messageReadGET /messages/{id}Retrieve a message.
catalog_create-a-new-messageWritePOST /messagesCreate a message.
catalog_list-all-templatesReadGET /templatesRetrieve the email templates in the account.
catalog_retrieve-a-templateReadGET /templates/{id}Retrieve a template.
catalog_create-a-templateWritePOST /templatesCreate an email template.
catalog_list-all-personalization-tagsReadGET /persTagsList all personalization tags.
catalog_list-variablesReadGET /personalizationsRetrieve a list of personalization variables.
catalog_personalization-tagsReadGET /stripo/personalizationTagsPersonalization tags.
catalog_retrieve-variableReadGET /personalizations/{variableId}Retrieve an individual personalization variable.
catalog_create-variableWritePOST /personalizationsCreate a personalization variable.
catalog_get-editor-markupReadGET /content/editorMarkup/{messageId}Get editor markup.

Brand Kits & Content Manager

Brand kits, branding settings, and Content Manager files and folders.

ToolTypeEndpointDescription
catalog_list-all-brand-kitsReadGET /ai/brandList all brand kits.
catalog_retrieve-a-brand-kitReadGET /ai/brand/{uuid}Retrieve a brand kit.
catalog_retrieve-brand-kit-competitorsReadGET /ai/brand/{uuid}/competitorsRetrieve a brand kit's competitors.
catalog_retrieve-brand-kit-toneReadGET /ai/brand/{uuid}/toneRetrieve a brand kit's tone.
catalog_retrieve-primary-brand-kitReadGET /ai/brand/primaryRetrieve the default (primary) brand kit.
catalog_create-a-brand-kitWritePOST /ai/brandCreate a brand kit.
catalog_brandingsReadGET /brandingsList the account's branding and white-label settings: site name, logo, favicon, header and footer content, admin template.
catalog_get-brandingReadGET /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-keywordsReadGET /content-proxy/files/{id}/tagsList the keywords on a Content Manager file.
catalog_list-content-manager-folder-filesReadGET /content-proxy/folders/{id}/filesList the files in a Content Manager folder.
catalog_list-content-manager-keyword-filesReadGET /content-proxy/tags/{id}/filesList the files with a keyword.
catalog_retrieve-a-content-manager-fileReadGET /content-proxy/files/{id}Retrieve a content manager file.
catalog_search-content-manager-filesReadGET /content-proxy/filesSearch the content manager for files.
catalog_list-all-content-manager-foldersReadGET /content-proxy/foldersList all content manager folders.
catalog_list-content-manager-file-foldersReadGET /content-proxy/files/{id}/foldersShow which folders a Content Manager file is in.
catalog_retrieve-a-content-manager-folderReadGET /content-proxy/folders/{id}Retrieve a content manager folder.

Automations & Goals

Automations, their triggers and steps, contact enrollments, and goals.

ToolTypeEndpointDescription
catalog_list-all-automationsReadGET /automationsList automations on the account.
catalog_list-all-goalsReadGET /goalsList all goals.
catalog_list-automation-stats-activity-itemsReadGET /statsActivityItem/get_seriesList recent automation entries.
catalog_retrieve-a-goalReadGET /goals/{id}Retrieve a goal.
catalog_retrieve-an-automationReadGET /automations/{id}Returns one automation's metadata (name, status, id).
catalog_retrieve-automation-blocksReadGET /automations/{id}/blocksRetrieve an automation's blocks.
catalog_retrieve-automation-triggersReadGET /automations/{id}/triggersRetrieve how contacts enter an automation (its start triggers).
catalog_retrieve-goal-showcaseReadGET /goal/showcaseHow 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-statsReadGET /goal/goalStatsCompletion statistics for one automation goal, ranked against the other goals in the same automation.
catalog_build-an-automationWritePOST /ai/automations/buildSave an automation from a drafted schema.
catalog_generate-an-automation-schemaWritePOST /ai/automations/schemaDraft an automation from a prompt.
catalog_list-all-contact-automationsReadGET /contactAutomationsList all automations a contact is in.
catalog_list-all-contactautomations-for-automationReadGET /automations/{seriesId}/contactAutomationsList all contacts in an automation.
catalog_list-all-contactautomations-for-contactReadGET /contacts/{id}/contactAutomationsList all automations the contact is in.
catalog_retrieve-a-contactautomationReadGET /contactAutomations/{id}Retrieve an automation a contact is in.
catalog_retrieve-contact-automation-stepsReadGET /automations/{seriesId}/contactAutomations/{contactAutomationId}/stepsRetrieve one contact's recorded steps and skip reason in an automation.
catalog_create-new-contactautomationWritePOST /contactAutomationsAdd a contact to an automation.
catalog_list-business-goalsReadGET /businessGoals/dataList business goals (agent-oriented read).
catalog_retrieve-a-business-goalReadGET /initiatives/{initiativeId}Retrieve a business goal.
catalog_retrieve-business-goal-dataReadGET /businessGoals/data/{initiativeId}Retrieve a business goal (agent-oriented read).
catalog_build-a-business-goalWritePOST /initiatives/buildbusinessgoalBuild a business goal from a schema.

Conversions

Conversions, conversion labels, and their metrics and trends.

ToolTypeEndpointDescription
catalog_list-conversion-metricsReadGET /conversions/metricsAgent-oriented read: event count, unique contacts, and total value per conversion.
catalog_list-conversionsReadGET /conversionsList conversions.
catalog_list-conversions-dataReadGET /conversions/dataRead-optimized conversion stats (counts, values, graph series), separate from GET /conversions.
catalog_retrieve-a-conversionReadGET /conversions/{id}Retrieve a conversion.
catalog_retrieve-a-conversions-dataReadGET /conversions/{id}/dataRetrieve a conversion's statistics.
catalog_retrieve-a-conversions-metricsReadGET /conversions/{id}/metricsRetrieve a conversion's metrics.
catalog_retrieve-a-conversions-trendsReadGET /conversions/{id}/trendsRetrieve a conversion's daily trend data.
catalog_create-a-conversionWritePOST /conversionsCreate a conversion.
catalog_list-conversion-labelsReadGET /conversions/labelsA 'conversion label' (ConversionFolder) is the association row between a conversion and a label/folder -- not the label itself.
catalog_retrieve-a-conversion-labelReadGET /conversions/labels/{id}Retrieve a conversion label.
catalog_create-a-conversion-labelWritePOST /conversions/labelsCreate a conversion label.

Deals & CRM

Deals, pipelines, stages, roles, tasks, task types, and saved responses.

ToolTypeEndpointDescription
catalog_list-all-dealsReadGET /dealsRetrieve all existing deals.
catalog_retrieve-a-dealReadGET /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-newWritePOST /dealsCreate a new deal.
catalog_create-a-deal-noteWritePOST /deals/{id}/notesCreate a deal note.
catalog_list-all-secondary-contactsReadGET /contactDealsList all secondary contacts.
catalog_retrieve-a-secondary-contactReadGET /contactDeals/{id}Retrieve a secondary contact.
catalog_create-a-secondary-contactWritePOST /contactDealsCreate a secondary contact.
catalog_list-all-deal-activitiesReadGET /dealActivitiesList all deal activities.
catalog_retrieve-inaccessible-pipelines-by-userReadGET /dealGroup/get_inaccessible_deal_groupsRetrieve inaccessible pipelines by user.
catalog_list-all-pipelinesReadGET /dealGroupsRetrieve all existing pipelines.
catalog_retrieve-a-pipelineReadGET /dealGroups/{id}Retrieve an existing pipeline.
catalog_create-a-pipelineWritePOST /dealGroupsCreate a new pipeline.
catalog_list-all-deal-stagesReadGET /dealStagesRetrieve all existing stages.
catalog_retrieve-a-deal-stageReadGET /dealStages/{id}Retrieve an existing stage.
catalog_create-a-deal-stageWritePOST /dealStagesCreate a new stage for a pipeline.
catalog_list-all-deal-rolesReadGET /dealRolesList all deal roles.
catalog_create-a-deal-roleWritePOST /dealRolesCreate a deal role.
catalog_list-all-deal-task-typesReadGET /dealTasktypesList all task types.
catalog_retrieve-a-deal-task-typeReadGET /dealTasktypes/{id}Retrieve a task type.
catalog_create-a-deal-task-typeWritePOST /dealTasktypesCreate a task type.
catalog_get-taskReadGET /dealTasks/{id}Retrieve an existing task.
catalog_list-all-tasksReadGET /dealTasksRetrieve a list of existing tasks.
catalog_create-taskWritePOST /dealTasksCreate a new task.
catalog_list-all-task-notificationsReadGET /taskNotificationsList deal task notification settings.
catalog_create-a-task-reminderWritePOST /taskNotificationsCreate a task reminder.
catalog_list-all-task-outcomesReadGET /taskOutcomesList all task outcomes.
catalog_retrieve-a-task-outcomeReadGET /taskOutcomes/{id}Retrieve a task outcome.
catalog_create-a-task-outcomeWritePOST /taskOutcomesCreate a task outcome.
catalog_list-all-task-type-outcome-relationsReadGET /tasktypeOutcomeRelsList all task type - outcome relations.
catalog_retrieve-a-task-type-outcome-relationReadGET /tasktypeOutcomeRels/{id}Retrieve a task type - outcome relation.
catalog_create-a-task-outcome-1WritePOST /tasktypeOutcomeRelsAssign a task outcome to a task type.
catalog_get-a-savedresponseReadGET /savedResponses/{id}Retrieve a saved response.
catalog_list-all-saved-responsesReadGET /savedResponsesList all saved responses.
catalog_saved-responsesWritePOST /savedResponsesCreate a saved response.
catalog_list-all-calendar-feedsReadGET /calendarsList all calendar feeds.
catalog_list-all-calendar-feeds-1ReadGET /calendars/{id}Retrieve a calendar feed.
catalog_create-a-calendar-feedWritePOST /calendarsCreate a calendar feed.

Accounts (CRM)

CRM accounts, their notes, and the contacts linked to them.

ToolTypeEndpointDescription
catalog_list-all-accountsReadGET /accountsRetrieve all existing account.
catalog_retrieve-an-accountReadGET /accounts/{id}Retrieve an existing account.
catalog_create-an-account-newWritePOST /accountsCreate a new account.
catalog_create-an-account-noteWritePOST /accounts/{id}/notesCreate an account note.
catalog_list-all-associations-1ReadGET /accountContactsLists links between contacts and accounts.
catalog_retrieve-an-associationReadGET /accountContacts/{id}Returns one link between a contact and an account.
catalog_create-an-account-1WritePOST /accountContactsLinks a contact to an account, optionally with the contact's job title there.

eCommerce

eCommerce connections, customers, orders, order products, and sales summaries.

ToolTypeEndpointDescription
catalog_get-customerReadGET /ecomCustomers/{id}Retrieve an existing e-commerce customer resource.
catalog_list-all-customersReadGET /ecomCustomersList all e-commerce customer resources.
catalog_retrieve-ecom-customer-behavior-summaryReadGET /ai/ecom/customerBehaviorSummaryRetrieve an ecommerce customer behavior summary.
catalog_create-customerWritePOST /ecomCustomersCreate a new e-commerce customer resource.
catalog_get-orderReadGET /ecomOrders/{ecomOrderId}Retrieve an existing e-commerce order resource.
catalog_list-all-ordersReadGET /ecomOrdersList all existing e-commerce order resources.
catalog_list-products-for-orderReadGET /ecomOrders/{id}/orderProductsList ecomorderproducts for a specific ecomorder.
catalog_retrieve-ecom-order-status-summaryReadGET /ai/ecom/orderStatusSummaryRetrieve an ecommerce order status summary.
catalog_retrieve-ecom-revenue-summaryReadGET /ai/ecom/revenueSummaryRetrieve an ecommerce revenue summary.
catalog_create-orderWritePOST /ecomOrdersCreate a new e-commerce order resource.
catalog_list-ecomorderproductsReadGET /ecomOrderProductsList ecomorderproducts.
catalog_retrieve-an-ecomorderproductReadGET /ecomOrderProducts/{id}Retrieve an ecomorderproduct.
catalog_retrieve-ecom-product-rankingsReadGET /ai/ecom/productRankingsRetrieve ranked ecommerce products.
catalog_get-connectionReadGET /connections/{id}Retrieve an existing connection resource.
catalog_list-all-connectionsReadGET /connectionsList all existing connection resources.
catalog_create-connectionWritePOST /connectionsCreate a new connection resource.

SMS & WhatsApp

SMS broadcasts, SMS credits, and WhatsApp templates, messages, and flows.

ToolTypeEndpointDescription
catalog_getAIBroadcastStatusReadGET /sms/broadcasts/ai/{Id}Get AI broadcast request status.
catalog_getBroadcastReadGET /sms/broadcasts/{id}Retrieves the full details for one broadcast message.
catalog_list-sms-broadcast-failuresReadGET /sms/broadcasts/metrics/{broadcastId}/failuresList SMS broadcast delivery failures.
catalog_list-sms-broadcast-recipientsReadGET /sms/broadcasts/{broadcastId}/recipientsList SMS broadcast recipients.
catalog_listBroadcastsReadGET /sms/broadcastsGet all broadcast messages.
catalog_retrieve-sms-metrics-snapshotReadGET /sms/broadcasts/metrics/snapshotRetrieve SMS broadcast metrics snapshot.
catalog_createAIBroadcastWritePOST /sms/broadcasts/aiCreate broadcast with AI.
catalog_createBroadcastWritePOST /sms/broadcastsCreate a new broadcast message.
catalog_exportBroadcastMetricsWritePOST /sms/broadcasts/exportExport broadcast performance metrics as CSV.
catalog_exportBroadcastRecipientsWritePOST /sms/broadcasts/{broadcastId}/recipients/exportExport recipient data as CSV including full contact records.
catalog_getBroadcastMetricsWritePOST /sms/broadcasts/metricsGet all broadcast metrics.
catalog_getBroadcastSnapshotByIdsWritePOST /sms/broadcasts/metrics/snapshotReturns snapshot for specified broadcast IDs.
catalog_get-sms-creditsReadGET /sms/creditsRetrieve SMS credit balance.
catalog_get-whatsapp-templateReadGET /channel/whatsapp/channels/whatsapp/template/{id}Gets a WhatsApp template by id.
catalog_list-whatsapp-templatesReadGET /channel/whatsapp/channels/whatsapp/templateList WhatsApp templates.
catalog_send-a-whatsapp-template-messageWritePOST /channel/whatsapp/channels/whatsapp/template/{id}/sendSend a WhatsApp template.
catalog_list-conversationsReadGET /channel/whatsapp/inbox/conversationList conversations.
catalog_get-flow-executionReadGET /channel/whatsapp/flow-execution/{id}Get flow execution by id.
catalog_get-flow-execution-contactReadGET /channel/whatsapp/flow-execution-contact/{id}Get flow execution contact by id.
catalog_list-flow-executionReadGET /channel/whatsapp/flow-executionList flow executions.
catalog_list-flow-execution-contactReadGET /channel/whatsapp/flow-execution-contactList flow execution contacts.

Site & Event Tracking

Site tracking, tracked domains, and event tracking.

ToolTypeEndpointDescription
catalog_retrieve-site-tracking-statusReadGET /siteTrackingRetrieve whether site tracking is enabled.
catalog_list-all-tracked-domainsReadGET /siteTrackingDomainsList all tracked domains.
catalog_list-all-whitelisted-domainsReadGET /prism/urlWhitelistingsList all whitelisted domains.
catalog_add-a-tracked-domainWritePOST /siteTrackingDomainsAdd a tracked domain by name.
catalog_add-domain-to-whitelistWritePOST /prism/urlWhitelistingsAdd domain to whitelist.
catalog_retrieve-event-tracking-statusReadGET /eventTrackingRetrieve event tracking status.
catalog_list-all-event-typesReadGET /eventTrackingEventsList all events (names only).
catalog_create-a-new-event-name-onlyWritePOST /eventTrackingEventsCreate a new event (name only).
catalog_get-contact-by-event-idReadGET /trackingLogs/{eventId}/contactLook up which contact produced a tracking log entry.
catalog_list-all-tracked-eventsReadGET /trackingLogsList the tracked events that have fired, with their contacts.
catalog_retrieve-a-tracking-logReadGET /trackingLogs/{id}Retrieve a tracking log entry.
catalog_retrieve-contact-tracking-logsReadGET /contacts/{id}/trackingLogsRetrieve a contacts tracking logs.

Forms

Forms and their opt-in confirmation emails.

ToolTypeEndpointDescription
catalog_forms-1ReadGET /formsList the account's forms with their settings, fields and actions.
catalog_retrieve-formsReadGET /forms/{id}Retrieve a form's settings, fields and actions.
catalog_post_formoptinWritePOST /form/optinCreate a form's opt-in confirmation email.
catalog_post_formsWritePOST /formsCreate a form.

Webhooks

Webhooks and the events they can subscribe to.

ToolTypeEndpointDescription
catalog_get-a-list-of-webhooksReadGET /webhooksList all existing webhooks.
catalog_get-webhookReadGET /webhooks/{id}Retrieve an existing webhook.
catalog_create-webhookWritePOST /webhooksCreate a new webhook.
catalog_get-a-list-of-webhook-eventsReadGET /webhook/eventsList the webhook event types available for subscription.

Account, Users & Permissions

Account information, users, user groups, and mailing addresses.

ToolTypeEndpointDescription
catalog_retrieve-account-informationReadGET /settings/accountRetrieve the hosted account and plan information for the account that owns the API key.
catalog_get-userReadGET /users/{id}Retrieve an existing user.
catalog_get-user-emailReadGET /users/email/{email}Retrieve a user by email.
catalog_get-user-loggedinReadGET /users/meRetrieve the logged-in user.
catalog_get-user-usernameReadGET /users/username/USERNAMERetrieve a user by username.
catalog_list-all-usersReadGET /usersList all existing users.
catalog_create-userWritePOST /usersCreate a new user with full account access, gated by their group (role).
catalog_list-all-groupsReadGET /groupsList all groups.
catalog_retrieve-a-groupReadGET /groups/{id}Retrieve a group.
catalog_create-a-new-groupWritePOST /groupsCreate a group.
catalog_get-all-custom-field-groupsReadGET /groupMembersGet All custom field groups.
catalog_get-custom-field-to-field-groupReadGET /groupMembers/{groupId}Get custom field group by ID.
catalog_add-custom-field-to-field-groupWritePOST /groupMembersAdd custom field to field group.
catalog_list-all-group-limitsReadGET /groupLimitsList All group limits.
catalog_list-all-addressesReadGET /addressesList all addresses.
catalog_retrieve-an-addressReadGET /addresses/{id}Retrieve an address.
catalog_create-an-addressWritePOST /addressesCreate a company mailing address for email footers.
catalog_list-all-address-groupsReadGET /addressGroupsList which user groups each mailing address belongs to.
catalog_retrieve-an-addressgroupReadGET /addressGroups/{id}Retrieve an addressGroup.
catalog_create-an-addressgroupWritePOST /addressGroupsAssociates an address with a group.
catalog_list-all-address-listsReadGET /addressListsList which lists each mailing address belongs to.
catalog_retrieve-an-addresslistReadGET /addressLists/{id}Retrieve an addressList.
catalog_create-an-addresslistWritePOST /addressListsAssociates an address with a list.