MCP server
All tools
Every tool the Happierleads MCP server gives your AI assistant, grouped by product area.
Your assistant sees these automatically and picks the right one for your request; you never call them by name. 230 tools: 99 read-only, 100 that change data, 31 that delete or overwrite data, 43 that act outside your account (send email, push to a CRM, charge a card) and 13 that can spend credits or money.
Account & billing
| Tool | What it does | |
|---|---|---|
get_account | Shows the signed-in account: plan, credit limits and remaining credits, refresh and trial dates, add-ons, features, settings, pause status, failed-payment flag and the account's websites (the first 11 only). | Read-only |
update_account_tracking_settings | Turns tracking options on or off for every website of the account at once: identify people, suggested contacts, personal emails, session recordings. | Changes data |
get_credit_summary | Credits used in a billing cycle, by source (website visitors, Prospector, AI Scout, Web Scraping…) and by day, with what is left. | Read-only |
list_billing_domains | The sending domains billed to the account, with their yearly price, renewal date and auto-renew. | Read-only |
list_open_invoices | The account invoices that are still open or past due, with amount and due date. | Read-only |
list_invoices | The account's invoices, newest first: date, amount, currency, status (paid, open) and a link to the PDF. | Read-only |
get_auto_topup | Whether auto top-up is on: when credits run out, a pack of leads is bought automatically, up to a monthly cap in USD. | Read-only |
set_auto_topup | Turns auto top-up on or off and sets the pack of leads bought each time credits run out and the monthly cap in USD. | Changes data |
get_billing | Returns the same subscription summary as get_subscription: plan, leads per month, credits used and remaining, top-up credits, price, billing interval, next billing date, whether it is set to cancel or is paused, pending downgrade and any running retention discount. | Read-only |
get_pricing | Returns the account's prices for outreach mailboxes and sending domains: mailboxPricePerMonthUSD (and the yearly equivalent), whether custom or default pricing applies, the defaults, and the outreach starter-kit state (available now, or earned on upgrade). | Read-only |
get_credit_history | Lists the account's credit transactions from the last 90 days, newest first: each row has operation (CHARGE, REFUND or DUPLICATE_PREVENTED), amount, credits before/after, the website, the lead's domain/email, a source category (WEBSITE_VISITOR, PROSPECTOR, ENRICHMENT, EMAIL_VERIFICATION, CONTACT_UNLOCK, INTENT_SIGNALS, ADJUSTMENT, OTHER), a reason and createdAt. | Read-only |
get_website_credit_history | Returns the credit snapshots stored for one website: each entry has creditsLimit, creditsRemaining, creditsUsed, refreshOn and timestamps. | Read-only |
get_subscription | Shows the current subscription: plan, tierName, leads per month, usedCredits, remaining, topUpCredits, refreshOn, price (monthly equivalent, USD), annualTotal, interval ('month' or 'year'), nextBillingDate, cancelAtPeriodEnd, subscriptionStatus, isPausedByUser/pausedUntil, pendingDowngrade, retentionDiscount and add-ons. | Read-only |
preview_plan_change | Shows what a plan change would cost without changing anything. | Read-only |
upgrade_plan | Moves the subscription to more leads per month right away and charges the card on file today. | Changes data · Credits |
downgrade_plan | Schedules the subscription to change to a new number of leads per month from the next billing date; nothing is charged or refunded now and current credits stay until then. | Changes data |
pause_subscription | Pauses the subscription for 1 to 6 months: invoices during the pause are not collected, no new leads come in while paused, and it resumes automatically on pausedUntil. | Deletes or overwrites data |
cancel_subscription | Cancels the subscription at the end of the current billing period (it stays usable until then) and records why. | Deletes or overwrites data |
reactivate_subscription | Undoes a cancellation that has not taken effect yet, or ends a pause early. | Changes data |
Free tools
| Tool | What it does | |
|---|---|---|
free_enrich_company | Free on every plan of a signed-in account, also after the trial ends, no credits used. | Read-only |
free_intent_signals | Free on every plan of a signed-in account, also after the trial ends, no credits used. | Read-only |
free_find_decision_makers | Free on every plan of a signed-in account, also after the trial ends, no credits used. | Read-only |
free_companies_using_tech | Free on every plan of a signed-in account, also after the trial ends, no credits used. | Read-only |
free_find_lookalikes | Free on every plan of a signed-in account, also after the trial ends, no credits used. | Read-only |
free_people_search | Free on every plan of a signed-in account, also after the trial ends, no credits used. | Read-only |
free_email_pattern | Free on every plan of a signed-in account, also after the trial ends, no credits used. | Read-only |
Team
| Tool | What it does | |
|---|---|---|
list_members | Lists the people on the account as team: userId, name, email, role (Owner or Member), permissions, preset, websites and whether their invite is still pending. | Read-only |
get_permissions_catalog | Returns every permission a member can be given and the presets (full, sales, developer, viewer, team, client) with the permissions each one ticks. | Read-only |
invite_members | Invites people to the account; each one receives an invitation email to set a password. | Changes data |
update_member | Changes a member's role, permissions or websites. | Changes data |
remove_member | Removes a person from the account: they lose access straight away. | Deletes or overwrites data |
Prospector
| Tool | What it does | |
|---|---|---|
create_contact | Saves a new person record (name, job title, company domain) and returns it with its _id. | Changes data |
verify_contact | Checks whether the email of a saved contact is valid and deliverable. | Changes data · Credits |
search_companies | Searches the company database by name or domain keyword, industry, HQ country, headcount, revenue and technologies. | Read-only |
search_people | Searches the 209M-contact people database by job title, company, company HQ country, seniority, department, industry, technology and company size. | Read-only |
reveal_contact | Returns the email address and phone number held for one person from search_people. | Changes data · Credits |
find_contact_email | Looks for a business email for one search_people contact by trying likely address patterns at their company and verifying each one. | Changes data · Credits |
list_auto_searches | Lists the Auto Searches of one website: name, status (running or paused), preferences, people per day, leads delivered today and in total, the matching pool and the last run. | Read-only |
build_auto_search_profile | Turns a plain-English description of the ideal customer ("founders of US SaaS companies with 10-200 staff") into Auto Search preferences: field, values and weight (Must, High, Prefer or Bonus). | Read-only |
create_auto_search | Creates an Auto Search and starts it: every day new people matching the preferences are verified and added to the website's leads, 1 credit per lead delivered, up to perDay a day, until it is paused. | Changes data · Credits |
pause_auto_search | Pauses one Auto Search: no more leads are delivered and no more credits are used until it is resumed. | Changes data |
resume_auto_search | Resumes a paused Auto Search: deliveries start again today, 1 credit per lead delivered. | Changes data · Credits |
get_icp | Returns the ideal customer profile (ICP) saved for a website: the companies the user wants to reach. | Read-only |
update_icp | Changes a website's ideal customer profile: target industries, sectors, HQ locations, headcount and revenue ranges. | Changes data |
Qualify (lead scoring)
| Tool | What it does | |
|---|---|---|
recalculate_lead_scores | Re-run lead scoring for specific leads against the website's current scoring models, and answer any AI qualification questions those leads do not have an answer for yet. | Changes data |
list_lead_scoring_models | List a website's lead scoring models (Qualify): the rules that score each lead on company, people and behaviour criteria and mark it warm or hot. | Read-only |
create_lead_scoring_model | Create a lead scoring model on a website, with its rules: criteria (same shape as get_lead_scoring_model / update_lead_scoring_model), active and aiMatching are saved with it. | Changes data |
ai_generate_scoring_model | Have AI build a lead scoring model from the website's own pages (it reads the site to infer the ideal customer) and save it as 'ICP Score - AI Generated'. | Changes data |
get_lead_scoring_model | Get one lead scoring model with all its rules. | Read-only |
update_lead_scoring_model | Change a lead scoring model's name, on/off state and/or rules. | Deletes or overwrites data |
delete_lead_scoring_model | Permanently delete a lead scoring model and remove its score from every lead of the website. | Deletes or overwrites data |
Automations & CRM
| Tool | What it does | |
|---|---|---|
get_lead_automation_history | List every automation run recorded for one lead, newest first, as automationLogs[] with status, message (the result or error text), automation (the automation id, see list_automations) and executedAt. | Read-only |
retrigger_automations | Runs a website's automations again for a list of leads, for example after a CRM or Slack connection was fixed. | Changes data |
list_crm_variables | The lead and company fields (name, email, job title, company size, pages visited, score…) that can be mapped to fields in your CRM. | Read-only |
get_crm_mappings | The field mappings used when leads are pushed to a CRM: which lead field fills which CRM field, for contacts and companies. | Read-only |
set_crm_mappings | Sets the field mappings for contacts or companies pushed to a CRM. | Deletes or overwrites data |
get_slack_message_template | The template of the message posted to Slack for each lead, with its merge fields. | Read-only |
set_slack_message_template | Changes the template of the message posted to Slack for each lead. | Changes data |
send_slack_test_message | Posts a sample lead message to a Slack channel so you can see how it looks. | Changes data |
test_webhook | Sends a sample lead, as automations send them, to a URL so you can check your endpoint receives and parses it. | Changes data |
preview_automation_filter | Counts the leads of the last days that match a saved filter, and shows a few of them, before you use the filter in an automation. | Read-only |
get_automation_stats | For every automation of a website: how many leads it handled, how many failed and when it last ran. | Read-only |
get_automation_runs | The runs of one automation, newest first: which lead each run handled, when, and whether it succeeded (and why not). | Read-only |
list_slack_channels | The channels of the Slack workspace connected to this website, to pick one for a Slack automation. | Read-only |
list_automations | Lists a website's automations: rules that act when a lead matches, for example sending to Slack, a CRM, a webhook, Zapier, an email or LinkedIn campaign, or an email alert. | Read-only |
create_automation | Creates an automation that is active straight away and runs whenever a lead matches it. | Changes data |
get_automation | Returns the full setup of one automation: name, isActive, when (trigger event), then (action), trigger, interval, frequency settings (repeatWindowHours, dedupeScope), contact selection, email verification rules, filter and the action settings. | Read-only |
update_automation | Changes an existing automation: its name, rule, action settings or on/off state. | Changes data |
delete_automation | Deletes an automation permanently, so it no longer acts on any lead. | Deletes or overwrites data |
toggle_automation | Switches an automation on or off without changing its setup. | Changes data |
rerun_automation_for_lead | Runs one type of automation again for a single lead right now and reports the outcome. | Changes data |
push_lead_to_crm | Creates a contact in the website's connected CRM: HubSpot, Pipedrive, Salesforce, Zoho or GoHighLevel. | Changes data |
list_crm_owners | Lists the users in a connected CRM that a contact can be assigned to. | Read-only |
Intent data
| Tool | What it does | |
|---|---|---|
get_intent_topics_catalog | Lists every third-party intent topic you can subscribe to, e.g. | Read-only |
list_intent_topics | Lists the intent topics a website is subscribed to, with delivery numbers. | Read-only |
subscribe_to_intent_topic | Subscribes a website to an intent topic, so companies researching that topic start arriving as leads each day, up to the daily limit. | Changes data · Credits |
update_intent_topic | Pauses or resumes an intent topic subscription, or changes its daily lead limit. | Changes data |
delete_intent_topic | Unsubscribes a website from an intent topic and deletes the subscription, including its delivery counters. | Deletes or overwrites data |
Campaigns & inbox
| Tool | What it does | |
|---|---|---|
list_email_blacklist | Lists the email addresses campaigns on this website never send to, grouped by the name they were added under. | Read-only |
add_to_email_blacklist | Adds email addresses that campaigns on this website must never send to, e.g. | Changes data |
remove_from_email_blacklist | Removes every address added under one group name; campaigns can email them again. | Deletes or overwrites data |
update_campaign | Renames a campaign, starts it (status active: emails start going out to its contacts) or pauses it, or changes its sending days (0 Sunday to 6 Saturday), hours (timeSlot start and end, 0-24), timezone or open/click tracking. | Changes data |
clone_campaign | Copies a campaign with its steps and settings, named '<name> (copy)'. | Changes data |
get_campaign_stats | Returns how a campaign is doing: emails sent, opened, clicked, replied, bounced and unsubscribed, with rates. | Read-only |
get_campaign_capacity | Returns the campaign's health: connected mailboxes and their daily limits, how many emails it can send a day, and what is holding it back (e.g. | Read-only |
add_campaign_step | Adds one email at the end of a campaign's sequence, sent delayDays after the previous one (the first step of an empty campaign becomes the opening email). | Changes data |
delete_campaign_step | Removes one email from a campaign's sequence for good. | Deletes or overwrites data |
reorder_campaign_steps | Puts a campaign's emails in a new order. | Changes data |
resume_prospects | Resumes paused prospects so their emails are sent again from their next scheduled step. | Changes data |
send_prospects_now | Sends the next email of their sequence to the given prospects right away instead of at their scheduled time, within the mailbox limits. | Changes data |
change_prospects_mailbox | Moves prospects to another mailbox: their next emails are sent from it. | Changes data |
reschedule_prospects | Recalculates when the next email of each prospect goes out, spread over the coming days within the mailbox limits, e.g. | Changes data |
generate_campaign_emails_ai | Writes a sequence of emails for a campaign with AI, from your website, offer and ideal customer, and saves them as the campaign steps. | Changes data |
list_linkedin_keywords | The keywords watched on LinkedIn (LinkedIn Fans): people who post or comment about them become leads. | Read-only |
add_linkedin_keyword | Starts watching a keyword on LinkedIn: people who post or comment about it become leads. | Changes data |
set_linkedin_keyword_status | Pauses or resumes watching one LinkedIn keyword. | Changes data |
delete_linkedin_keyword | Stops watching a LinkedIn keyword for good and removes it from the list. | Deletes or overwrites data |
list_linkedin_tracked_posts | The LinkedIn posts being tracked: people who react to or comment on them become leads. | Read-only |
add_linkedin_tracked_post | Starts tracking a LinkedIn post (yours or someone else’s): people who react to or comment on it become leads. | Changes data |
update_linkedin_account | Changes the label of a connected LinkedIn account, or pauses and resumes it (paused: its campaigns send nothing). | Changes data |
list_google_ads_audiences | The Google Ads retargeting audiences of a website: name, linked Google campaign, contacts uploaded and match stats. | Read-only |
get_google_ads_audience | One retargeting audience: settings, contacts uploaded, match rate and the stats of its Google campaign. | Read-only |
sync_google_ads_audience_stats | Fetches the latest impressions, clicks and conversions of an audience’s campaign from Google Ads. | Changes data |
dismiss_campaign_capacity_warning | Hides a campaign's capacity warning (more contacts than its mailboxes can send to in time) for some days. | Changes data |
spam_check_email | Checks an email subject and body for words and patterns that send mail to spam, and returns a score with each issue and how to fix it. | Read-only |
get_linkedin_campaign | One LinkedIn campaign of this website: its settings and the people in it with their status (invited, connected, messaged, replied), optionally one status, page by page. | Read-only |
get_linkedin_campaign_timeline | What a LinkedIn campaign did day by day over the last days: invitations sent, accepted, messages sent and replies. | Read-only |
activate_linkedin_campaign | Starts a LinkedIn campaign: it begins sending invitations and messages from the connected LinkedIn account, within the account's daily LinkedIn limits. | Changes data |
pause_linkedin_campaign | Pauses a running LinkedIn campaign: nothing more is sent until it is resumed. | Changes data |
resume_linkedin_campaign | Resumes a paused LinkedIn campaign: it continues sending invitations and messages where it stopped. | Changes data |
delete_linkedin_campaign | Deletes a LinkedIn campaign and stops everything it would still send. | Deletes or overwrites data |
get_email_template | Returns one email (step) of a campaign in full: subject and body templates with their merge fields, the sender, the delay before it is sent and its position in the sequence. | Read-only |
get_prospects | List the contacts (prospects) already added to email campaigns on a website, newest first. | Read-only |
list_campaigns | List the email campaigns of one website, newest first, with their status (isActive), schedule, steps (emailCampaignTemplates), health and a cached stats snapshot (statsRollup: contacted, sent, opens, clicks, replies, bounces and rates, refreshed about every 5 minutes; see computedAt). | Read-only |
create_campaign | Create a new email sequence: the campaign plus one email per entry in steps (the first is the initial email, the rest follow-ups). | Changes data |
update_campaign_step | Rewrite one email (step) of an existing campaign: its subject, body and/or delay. | Changes data |
get_campaign | Get one email campaign with live analytics: settings (isActive, schedule, timezone), its steps in emailCampaignTemplates[] (each with _id = templateId for update_campaign_step, subject, body and per-step stats), stats (prospect total, scheduledCount, uniqueContacted, totalEmailsSent, opens, clicks, replies, warm replies, bounced, unsubscribed and their rates), steps[] (per-step sent/opened/clicked/replied), statusBuckets (prospect counts per status) and statistics (sent vs scheduled over time). | Read-only |
add_prospect_to_campaign | Add one contact to an existing email campaign so it receives the sequence, like Manual Entry in the app. | Changes data |
remove_prospect_from_campaign | Delete a prospect from its campaign, like "Remove from campaign" in the app: the prospect and its scheduled emails are deleted, emails already sent stay sent, and its history is gone. | Deletes or overwrites data |
stop_prospect | Stop one prospect's email sequence: no further steps are sent and the prospect is marked manually-paused, keeping it and its history in the campaign. | Deletes or overwrites data |
list_linkedin_accounts | List the LinkedIn accounts connected to a website through the browser extension, newest first. | Read-only |
list_linkedin_campaigns | List the LinkedIn connection-request campaigns of a website, newest first, with each campaign's status (draft, active, paused, completed), stats and progress ({ pct, terminalCount, total }). | Read-only |
get_inbox_emails | List prospects from the outreach master inbox of a website across all campaigns, most recent activity first. | Read-only |
get_email_thread | Read one outreach email conversation: the email that was sent (subject, send time, opens) and every reply under it, incoming and outgoing. | Read-only |
reply_to_prospect | Send a reply email to a prospect in an existing outreach conversation. | Changes data |
archive_email | Archive one email conversation in the outreach master inbox so it leaves the inbox view; it stays visible with get_inbox_emails status archived. | Changes data |
delete_campaign | Permanently delete an email campaign together with all its steps and every prospect in it; scheduled emails are never sent and the history is lost. | Deletes or overwrites data |
Mailboxes & domains
| Tool | What it does | |
|---|---|---|
list_email_providers | Returns the SMTP and IMAP host, port and TLS settings of common providers (Gmail, Outlook, Zoho…). | Read-only |
test_email_account | Connects to the SMTP and IMAP servers with these settings and says whether sending and reading work, without saving anything. | Read-only |
update_warmup_settings | Changes how hard a mailbox warms up: intensity conservative, normal or aggressive, and the most warmup emails a day (5-100). | Changes data |
get_warmup_health | Returns one mailbox's warmup health: reputation, inbox vs spam placement and what to fix. | Read-only |
verify_tracking_domain | Checks that a mailbox's custom tracking domain has its CNAME record set, so open and click tracking links use your own domain. | Changes data |
list_domains | The domains bought or imported for sending, with their mailboxes, DNS state, expiry date and auto-renew. | Read-only |
set_domain_auto_renew | Turns automatic yearly renewal of a sending domain on or off. | Changes data |
rename_email_account | Changes the sender name a mailbox shows, and for mailboxes on our servers the part of the address before the @. | Changes data |
reconnect_email_account | Tries the saved SMTP and IMAP settings of a disconnected mailbox again; when they work, the mailbox is connected and its paused prospects continue. | Changes data |
unmark_email_account_spam | Clears the flag set when a mailbox looked like it was going to spam, so it sends again. | Changes data |
remove_tracking_domain | Stops using the custom open and click tracking domain of a mailbox; tracking falls back to the shared domain. | Deletes or overwrites data |
get_email_account | One mailbox in full: address, sender name and signature, daily sending limit, warmup state and health, and whether it is connected. | Read-only |
update_email_account | Changes a mailbox: the daily sending limit (queued emails are rescheduled to match), the sender name, company, position, phone and the HTML signature. | Changes data |
list_email_accounts | List the mailboxes connected to a website for sending outreach, with their health and warmup state. | Read-only |
add_email_account | Connect an existing mailbox to a website for sending outreach, using its SMTP (sending) and IMAP (reading replies) settings. | Changes data |
get_email_account_stats | Get the sending load of every mailbox on a website: how many campaign emails are scheduled on it and how full its next 30 days are. | Read-only |
delete_email_account | Remove a connected mailbox from the account. | Deletes or overwrites data |
toggle_warmup | Turn email warmup on or off for one mailbox. | Changes data |
get_warmup_stats | Get warmup statistics for all mailboxes on a website: totals (mailboxes, warmup on, connected, warmup emails sent and received) and per mailbox the daily volume, inbox placement and reputation. | Read-only |
run_deliverability_check | Run the deliverability check for one mailbox: SPF, DKIM and DMARC of its domain, its custom tracking domain and an IP blacklist score. | Changes data |
get_domain_suggestions | Suggest look-alike domain names for cold outreach, built from the website's own domain and keeping its ending (e.g. | Read-only |
search_domain_availability | Check whether a domain can be registered for outreach and what it costs. | Read-only |
add_outreach_domain | Add an available domain to a website's picked list (the purchase cart). | Changes data |
remove_outreach_domain | Remove a domain from a website's picked list (purchase cart) before it is bought. | Changes data |
purchase_outreach_domains | Buy every domain in the website's picked list (added with add_outreach_domain) and set each one up for outreach: registration, DNS, SPF/DKIM/DMARC, a mailbox and warmup. | Deletes or overwrites data · Credits |
get_domain_setup_status | Check the setup progress of the outreach domains bought for a website (unpaid picks are not shown). | Read-only |
list_outreach_domains | List every outreach domain of a website, picked or bought, with its status, setup progress, mailboxes and expiry. | Read-only |
AI Scout
| Tool | What it does | |
|---|---|---|
list_ai_scouts | Lists the AI Scouts of one website: name, description, status (running or paused), people per day, minimum fit, the sources it reads (readsFrom) and how many people each delivered, plus the website's daily AI Scout limit. | Read-only |
get_ai_scout | One AI Scout with its sources, how many people it found, qualified and delivered, and the latest people it picked with why they fit. | Read-only |
plan_ai_scout | Turns a description of who to find ("founders of B2B SaaS companies who talk about outbound on podcasts") into a scout name and the sources it would read. | Read-only |
create_ai_scout | Creates an AI Scout and runs it right away. | Changes data · Credits |
update_ai_scout | Changes an AI Scout's name, description, people per day, minimum fit or sources. | Changes data |
pause_ai_scout | Pauses an AI Scout: no more people are delivered until it is resumed. | Changes data |
resume_ai_scout | Resumes a paused AI Scout. | Changes data · Credits |
run_ai_scout | Starts a run of an AI Scout now instead of waiting for its daily run. | Changes data · Credits |
delete_ai_scout | Deletes an AI Scout: it stops for good and is removed from the list. | Deletes or overwrites data |
set_ai_scout_daily_limit | Sets how many AI Scout leads (= credits) the website may receive per day across all its scouts, 1 to 500. | Changes data |
Web Scraping keywords
| Tool | What it does | |
|---|---|---|
get_web_scraping | Web Scraping looks for your keywords on websites across the open web — in the page text or in the scripts a site loads — and adds the companies that match, with their people, as leads under Leads › Web Scraping. | Read-only |
update_web_scraping | Turns Web Scraping on or off and sets its keywords (exact or fuzzy match, each can be paused), the daily limit (1-500 leads, 1 credit each) and contacts-only (only companies where we found a person). | Changes data · Credits |
suggest_web_scraping_keywords | Keyword ideas for Web Scraping: phrases the website's buyers would write about themselves on their own sites (never the seller's own category words). | Read-only |
Optimize blog
| Tool | What it does | |
|---|---|---|
list_blog_articles | Lists the articles on a website's hosted blog (Optimize add-on), newest first. | Read-only |
get_blog_article | Returns one blog article in full (Optimize add-on): its content blocks, FAQ, every version with its status, the public url and the visits it received. | Read-only |
create_blog_article | Publishes a hand-written article on the website's hosted blog at <blog>/<slug>, or saves it as a draft (Optimize add-on). | Changes data |
update_blog_article | Edits a blog article by saving a new version at the same URL (Optimize add-on). | Changes data |
clear_blog_cache | Clears every cached copy of the website's hosted blog (Optimize add-on), so visitors get the latest version on their next page load. | Changes data |
Websites & tracking
| Tool | What it does | |
|---|---|---|
list_websites | Lists the account's tracked websites, newest first, with _id (the websiteId other tools need), name, url, domain, clientId, status (unverified, verified, removed or failed), trial and credit fields, tags and tracking settings. | Read-only |
add_website | Creates a new website on the account and returns only its websiteId. | Changes data |
get_website | Returns one website's details: name, url, domain, clientId, trackingScript (the install snippet), status (unverified, verified, removed or failed), lastVerifiedAt, tracking settings (identifySettings, trackExactVisitors, trackCompanyWithSuggestedContacts, trackPersonalEmails, session recording, email digest), credit limits and remaining, trial dates, tags, intent-topic state, integrations and members. | Read-only |
get_tracking_pixel | Returns the JavaScript snippet to install on a website so visitors can be identified, plus websiteId, clientId, status and url. | Read-only |
verify_website | Loads the website's home page (from its saved url) and checks whether this website's tracking snippet is in the HTML. | Changes data |
update_website | Changes a website's name, url and tracking settings. | Changes data |
delete_website | Deletes a website: tracking stops, it disappears from list_websites and its leads are no longer shown, and its website slot is freed. | Deletes or overwrites data |
get_website_analytics | Summarises who the identified leads on a website are, over a date range (default the last 30 days): top 10 industries, all company-size ranges, top 10 job titles and top 5 countries, each with a count. | Read-only |
get_website_daily_stats | Returns one row per day for a website (default the last 30 days, every day included even with 0): date (YYYY-MM-DD, UTC), leadsIdentified, avgIcpScore and leadsWithIcpScore. | Read-only |
get_website_diagnostics | Checks why a website may not be producing leads. | Read-only |
set_website_tags | Sets the labels of a website, used to group websites (for example by client or market) in the websites list. | Changes data |
set_page_tracking_rules | Sets the page rules of a website. | Deletes or overwrites data |
set_website_limits | Sets how many of the account's credits and mailboxes one website may use, for accounts that share them between websites (for example one website per client). | Changes data |
get_country_blacklist | Returns the countries whose visitors are never identified on this website (two-letter codes such as DE or FR). | Read-only |
set_country_blacklist | Sets the countries whose visitors are never identified on this website. | Deletes or overwrites data |
search_locations | Looks up location names as the location filters expect them: every country with city data, US states (optionally matching q) or cities matching q (optionally within one country). | Read-only |
get_domain_blacklist | Lists the company domains blocked from becoming leads on a website. | Read-only |
add_to_domain_blacklist | Blocks company domains from becoming new leads on a website (e.g. | Changes data |
remove_from_domain_blacklist | Deletes a whole named group of blocked domains from a website, so those companies can become leads again. | Deletes or overwrites data |
Visitors (leads)
| Tool | What it does | |
|---|---|---|
get_leads | List the identified visitors (leads) of one website whose last visit falls in a date range, newest first: the exact person (exactPerson: name, email, phone, LinkedIn, position), their company, visitor location, pages viewed, visits, UTM data, tags and lead scores. | Read-only |
get_lead | Get one lead's company profile and visit history: company (name, domain, industry, sector, type, founded year, location, employee range, estimated revenue, LinkedIn/Facebook pages), tags, UTM values, pageVisits[] (url, path, timeSpentMs/timeSpentSeconds, visitCount, sorted by time spent) and summary (totalVisits, lastVisit, totalTimeOnSiteMs, referrer), plus CRM record ids when the lead was pushed. | Read-only |
get_lead_ai_summary | Get a short AI-written summary (about 50 words) of what this visitor did on your website, based on their company, country and the pages they viewed, ending with one verdict: 'Ready to Buy', 'Research' or 'Just Browsing'. | Read-only |
tag_lead | Attach an existing tag to a lead. | Changes data |
remove_tags_from_lead | Remove one tag from a lead. | Changes data |
hide_lead | Hide a lead from the leads list (hide=true, the default) or bring a hidden lead back (hide=false). | Changes data |
delete_lead | Permanently delete one or more leads. | Deletes or overwrites data |
export_leads_csv | Queue a CSV export of a website's leads whose last visit falls in the date range. | Changes data |
enrich_domain | Look up the people known at a company domain and return them as contacts[] (name, position, email, LinkedIn, isDecisionMaker, plus scores against your scoring models when they have job-title rules). | Changes data · Credits |
list_lists | Lists the contact or company lists of one website with their names and ids. | Read-only |
create_list | Creates an empty contact or company list on a website and returns it. | Changes data |
get_list | Returns one list with its contacts or companies, page by page. | Read-only |
delete_list | Deletes a list for good. | Deletes or overwrites data |
remove_list_items | Removes contacts or companies from a list; they stay in the account. | Deletes or overwrites data |
export_list_csv | Builds a CSV of a list and emails the download link to the user. | Changes data |
update_filter | Marks a saved leads filter as a favourite (shown first) or not. | Changes data |
block_domain | Adds a company domain to the website exclusions: its visitors are not identified and use no credits. | Changes data |
block_person | Excludes one person (by email, LinkedIn URL or name) from the leads of a website, e.g. | Changes data |
purge_leads_below_bar | Removes the leads already in the table that score below the lead quality bar (get_lead_quality). | Deletes or overwrites data |
undo_lead_purge | Brings back the leads removed by the last purge_leads_below_bar, with their tags, comments and history as they were. | Changes data |
update_tag | Renames a tag or changes its colour on this website. | Changes data |
delete_tag | Deletes a tag from this website; it is removed from every lead that had it. | Deletes or overwrites data |
update_lead_notes | Sets the free-form notes on a lead, replacing what was there; an empty string clears them. | Changes data |
get_company_people | Other people who work at the company of a lead (name, job title, department, seniority, LinkedIn), optionally only one department, to find the right contact when the visitor was not the buyer. | Read-only |
rename_list | Renames a contact or company list of this website. | Changes data |
set_session_recording | Turns session recordings on or off for one website. | Changes data |
get_lead_quality | Returns the lead quality settings of a website: the minimum ideal-customer score a lead needs to be kept, the bar per source (website visitors, intent, Web Scraping, Prospector, AI Scout), contacts-only options and the audience focus (B2B, B2C or both). | Read-only |
update_lead_quality | Changes the lead quality settings of a website. | Changes data |
list_tags | List the tags available on a website: the website's own tags plus the built-in default tags. | Read-only |
create_tag | Create a new tag on a website so you can label leads with tag_lead. | Changes data |
list_filters | List the saved lead filters (saved views) of a website. | Read-only |
create_filter | Save a lead filter under a name so it shows as a saved view on the leads page and can be used as an automation segment. | Changes data |
delete_filter | Delete a saved lead filter. | Deletes or overwrites data |
get_lead_comments | Get the comments (team notes) on a lead. | Read-only |
add_lead_comment | Add a note to a lead, visible to everyone on the account's team, signed with the connected user's name. | Changes data |
update_lead_comment | Replace the text of an existing lead comment. | Deletes or overwrites data |
delete_lead_comment | Permanently delete a comment from a lead. | Deletes or overwrites data |
get_lead_recordings | List session recordings (replays of what a visitor did on your website), newest first, up to 100. | Read-only |
get_recording_url | Get a signed playback link for one session recording. | Read-only |
free_email_pattern
Free on every plan of a signed-in account, also after the trial ends, no credits used.
get_account
Shows the signed-in account: plan, credit limits and remaining credits, refresh and trial dates, add-ons, features, settings, pause status, failed-payment flag and the account's websites (the first 11 only).