--- canonical_url: "https://docs.composio.dev/toolkits/leadmagic" markdown_url: "https://docs.composio.dev/toolkits/leadmagic.md" product: "platform" version: null last_updated: null --- # LeadMagic LeadMagic provides people, company, jobs, advertising, and enrichment data for sales and recruiting workflows. - **Category:** people & contact data - **Auth:** API_KEY - **Composio-managed OAuth available?** N/A - **Tools:** 109 - **Triggers:** 0 - **Slug:** `LEADMAGIC` - **Version:** 20261014_01 - **Instant:** Supported on the latest version. Support varies by tool. ## Tools ### Add Emails To Suppression List **Slug:** `LEADMAGIC_ADD_EMAILS_TO_SUPPRESSION_LIST` Add a non-empty plaintext email list to one owned suppression list; LeadMagic stores only normalized SHA-256 hashes. Use the exact list_id captured in the same create lifecycle and only addresses intentionally owned by that workflow. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `emails` | array | Yes | Non-empty plaintext email list to add. LeadMagic normalizes and SHA-256 hashes each address server-side; use only lifecycle-owned addresses. | | `list_id` | string | Yes | Exact suppression-list identifier captured from Create Email Suppression List in the same owned lifecycle. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Credit Budget **Slug:** `LEADMAGIC_CREATE_CREDIT_BUDGET` Create a persistent credit budget that caps spend for one LeadMagic scope. Record the returned id so the owned budget can be updated or deleted later. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `scope` | string | Yes | Budget scope type defined by LeadMagic. | | `period` | string | No | Budget reset period defined by LeadMagic. | | `alert_email` | string | No | Email address that receives budget threshold alerts. | | `max_credits` | number | Yes | Maximum credits available to this budget during each period. | | `scope_value` | string | Yes | Workspace value to which the budget applies. | | `alert_threshold_pct` | number | No | Fraction of the budget at which an alert is sent, from 0 to 1. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Email Suppression List **Slug:** `LEADMAGIC_CREATE_EMAIL_SUPPRESSION_LIST` Create an owned suppression list from a unique list_id and non-empty plaintext email list. LeadMagic hashes emails server-side. Capture the returned list_id, use only that exact ID for subsequent reads or mutations, and always delete the owned list at the end of the lifecycle. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `emails` | array | Yes | Non-empty plaintext email list to suppress. LeadMagic normalizes and SHA-256 hashes each address server-side; use only addresses owned by this workflow. | | `list_id` | string | Yes | Unique identifier for the new suppression list. Use a workflow-specific value that cannot collide with a pre-existing workspace list. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Job Search Export V3 **Slug:** `LEADMAGIC_CREATE_JOB_SEARCH_EXPORT_V3` Synchronously export up to 5,000 matching jobs. At least one search filter is required. This route is credit-metered, but LeadMagic does not publish an exact rate. The limit defaults to 1 and bounds result count, not guaranteed credit exposure; use credits_consumed as finalized spend. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tags` | object | No | Job tag include and exclude filters. | | `limit` | integer | No | Maximum jobs to return (1-5000). Defaults to 1. LeadMagic documents this export as credit-metered but does not publish an exact rate, so this bounds result count rather than guaranteed credit exposure. | | `salary` | object | No | Normalized annual salary filters. | | `titles` | object | No | Title include, exclude, and semantic matching filters. | | `location` | object | No | Country, region, state, and city filters. | | `companies` | object | No | Company name, domain, or canonical ID filters. | | `work_modes` | array | No | Canonical work-mode IDs to include. | | `posted_within` | integer | No | Only return jobs posted within this many days (1-365). | | `include_company` | boolean | No | Include company details for each exported job. | | `include_description` | boolean | No | Include full job descriptions in the export. | | `occupation_taxonomy` | object | No | Occupation taxonomy filters by hierarchy level. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Credit Budget **Slug:** `LEADMAGIC_DELETE_CREDIT_BUDGET` Permanently delete one credit budget. This is an irreversible teardown action: use only the exact budget ID captured from Create Credit Budget in the same owned lifecycle, and never delete a budget discovered by listing workspace data. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Exact credit-budget identifier captured when this workflow created the budget. Never use an ID selected from pre-existing workspace budgets. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Email Suppression List **Slug:** `LEADMAGIC_DELETE_EMAIL_SUPPRESSION_LIST` Permanently delete an entire suppression list and its stored hashes. This is an irreversible teardown action: use only the exact list_id captured from Create Email Suppression List in the same owned lifecycle, never a pre-existing list. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_id` | string | Yes | Exact suppression-list identifier captured from Create Email Suppression List in the same owned lifecycle. Never use an ID discovered by listing. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Detect Job Change **Slug:** `LEADMAGIC_DETECT_JOB_CHANGE` Check whether a person has changed jobs relative to an expected company. A resolved check costs 3 credits; PROFILE_NOT_FOUND costs 0 credits. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `profile_url` | string | Yes | Professional profile URL or identifier for the person to check. | | `company_name` | string | No | Expected current company name. Provide this or company_domain. | | `company_domain` | string | No | Expected current company domain. Provide this or company_name. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Download Bulk Job Results CSV **Slug:** `LEADMAGIC_DOWNLOAD_BULK_JOB_RESULTS_CSV` Download all result rows for an owned bulk job as a CSV file. Use only a jobId captured from the same submission chain. The streamed download is offloaded and fails if it exceeds the documented 50 MiB bulk source-size bound. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `job_id` | string | Yes | UUID captured from a bulk job created by this workflow. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Enrich Company V1 **Slug:** `LEADMAGIC_ENRICH_COMPANY_V1` Call POST /v1/companies/company-search to enrich one company from its domain, name, or business profile identifier. A successful enriched-company result costs 1 credit; use credits_consumed as the finalized spend. **Instant:** Supported on the latest version. **Instant pricing:** $0.019 per company enriched #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `profile_url` | string | No | Business company profile URL or identifier. | | `company_name` | string | No | Company name when its domain or profile URL is unavailable. | | `company_domain` | string | No | Company domain, such as example.com. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Enrich Company V3 Docs Alias **Slug:** `LEADMAGIC_ENRICH_COMPANY_V3_DOCS_ALIAS` Call the distinct documented POST /v3/companies/enrich alias. Prefer SEARCH_COMPANIES for new integrations. Returns one cursor-controlled page. This route remains ordinarily metered even when browsing routes are unmetered; LeadMagic does not state an exact alias-specific charge, so use credits_consumed as finalized spend. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum companies on this page (1-50). This does not fetch later pages. | | `query` | string | No | Free-text company search query. | | `cursor` | string | No | Opaque next_cursor from the previous response. Pass it unchanged; the original criteria and limit are restored safely. | | `domain` | string | No | Documented alias for company_domain. | | `offset` | integer | No | Legacy unstable offset. Prefer cursor pagination; use offset 0 when starting or continuing a cursor search. | | `website` | string | No | Company website URL or domain. | | `profile_url` | string | No | Professional company profile URL. | | `company_name` | string | No | Company name to look up or search. | | `linkedin_url` | string | No | Documented alias for a professional company profile URL. | | `company_domain` | string | No | Direct one-company lookup domain, such as example.com. | | `company_filters` | object | No | Typed company filters for identity, firmographics, geography, funding, contact coverage, web presence, and technologies. Unset fields are omitted. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Find Company Competitors V1 **Slug:** `LEADMAGIC_FIND_COMPANY_COMPETITORS_V1` Find competitors from a company domain, profile, or name. A successful competitor list costs 5 credits. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `company_url` | string | No | Business company profile URL or identifier. | | `company_name` | string | No | Company name. | | `company_domain` | string | No | Company website domain. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Find Company Employees V1 **Slug:** `LEADMAGIC_FIND_COMPANY_EMPLOYEES_V1` Find up to 10 employees at one company, returning names, titles, locations, and professional profile URLs. Provider documentation conflicts between 0.05 and 1 credit per returned employee, so treat 1 credit per result as the exposure bound and use credits_consumed as finalized spend. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum employees to return (1-10). Billing evidence conflicts between 0.05 and 1 credit per returned employee; use 1 for minimum exposure. | | `company_name` | string | No | Company name when its domain is unavailable. Provide this or company_domain. | | `company_domain` | string | No | Company website domain, preferred when known. Provide this or company_name. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Find Jobs V1 **Slug:** `LEADMAGIC_FIND_JOBS_V1` Call POST /v1/jobs/jobs-finder to find jobs with the LeadMagic V1 filters. Each returned job costs 1 credit; an empty result costs 0 credits. per_page is capped at 50. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | One-based result page number. | | `location` | string | No | Job location text to match. | | `per_page` | integer | No | Results per page (1-50). Each returned job costs 1 credit. | | `city_name` | string | No | City name; pair with country_id when ambiguous. | | `job_title` | string | No | Job title to match. | | `region_id` | integer | No | Canonical region ID. | | `country_id` | string | No | Country code such as US or GB. | | `has_remote` | boolean | No | True for remote-capable jobs or false for non-remote jobs. | | `job_type_id` | integer | No | Canonical job-type ID. | | `company_name` | string | No | Company name to match. | | `posted_after` | string | No | Only return jobs posted on or after this date. | | `max_employees` | integer | No | Maximum company employee count. | | `min_employees` | integer | No | Minimum company employee count. | | `posted_before` | string | No | Only return jobs posted on or before this date. | | `posted_within` | integer | No | Only return jobs posted within this many days. | | `company_type_id` | integer | No | Canonical company-type ID. | | `company_website` | string | No | Company website or domain to match. | | `job_description` | string | No | Keyword or phrase to match in job descriptions. | | `experience_level` | string ("entry" | "mid" | "senior" | "executive") | No | Required experience level. | | `company_industry_id` | integer | No | Canonical company-industry ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Find Lookalike Companies V3 **Slug:** `LEADMAGIC_FIND_LOOKALIKE_COMPANIES_V3` Find similar companies from a seed domain, name, or description. The OpenAPI contract documents a flat 5-credit charge for a non-empty result and no charge when empty; another provider surface says 1 credit, so use credits_consumed as the finalized spend. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | Alias for company_name. | | `seed` | object | No | Optional seed object; prefer seed.domain. | | `limit` | integer | No | Maximum lookalike companies to return (1-2000). | | `domain` | string | No | Alias for company_domain. | | `offset` | integer | No | Zero-based result offset. | | `filters` | object | No | Alias for company_filters. | | `website` | string | No | Seed website URL or domain. | | `description` | string | No | Free-text seed description. | | `company_name` | string | No | Seed company name used when no domain is supplied. | | `company_domain` | string | No | Seed company domain. | | `company_filters` | object | No | Full Company Search filter object. | | `company_website` | string | No | Alias for website. | | `company_description` | string | No | Alias for description. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Find Mobile Phone **Slug:** `LEADMAGIC_FIND_MOBILE_PHONE` Find one person's mobile phone number from a professional profile URL or known email. A found mobile number costs 5 credits; no result is free. Exactly one person is processed per call. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `work_email` | string | No | A known work email for the person. | | `profile_url` | string | No | The person's professional profile URL or profile identifier. | | `personal_email` | string | No | A known personal email for the person. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Find Personal Email **Slug:** `LEADMAGIC_FIND_PERSONAL_EMAIL` Find one person's personal email addresses from a professional profile URL or identifier. A successful result costs 2 credits. Personal email addresses are sensitive personal data; use this tool only for a lawful, authorized purpose. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `profile_url` | string | Yes | The person's professional profile URL or profile identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Find Person By Role V1 **Slug:** `LEADMAGIC_FIND_PERSON_BY_ROLE_V1` Find one person by job title at a specified company. A successful match costs 2 credits; rely on credits_consumed as finalized spend. The response can contain personal identity and professional profile data. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `job_title` | string | Yes | Job title or role to find at the company. | | `company_name` | string | No | Company name or business profile identifier. Provide this or company_domain. | | `company_domain` | string | No | Company website domain. Provide this or company_name. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Find Work Email **Slug:** `LEADMAGIC_FIND_WORK_EMAIL` Find one person's work email from their name and company domain or name. A found valid email costs 1 credit; no result is free. Exactly one person is processed per call. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `full_name` | string | No | The person's full name. Provide this or first_name. | | `last_name` | string | No | The person's last name; use with first_name when known. | | `first_name` | string | No | The person's first name when not using full_name. | | `company_name` | string | No | The employer's name when its domain is unknown. Provide this or company_domain. | | `company_domain` | string | No | The employer's bare domain, such as example.com. Provide this or company_name. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Find Work Email From B2B Profile **Slug:** `LEADMAGIC_FIND_WORK_EMAIL_FROM_B2B_PROFILE` Find one person's work email from a professional profile URL or slug. LeadMagic's published sources conflict on whether a successful result costs 1 or 5 credits; treat 5 credits as the maximum documented exposure and use credits_consumed as finalized spend. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `profile_url` | string | Yes | The person's professional profile URL or profile slug. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Account Overview **Slug:** `LEADMAGIC_GET_ACCOUNT_OVERVIEW` Return the connected workspace's available credits, API-key permission summary, current rate limits, and today's usage. This read is free. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Analytics All Time Summary **Slug:** `LEADMAGIC_GET_ANALYTICS_ALL_TIME_SUMMARY` Get documented lifetime account request, credit, product, success, and latency statistics, optionally restricted to a date range. This free analytics route was not individually live-probed during the build. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `end_date` | string | No | Optional last date to include, in YYYY-MM-DD format. | | `start_date` | string | No | Optional first date to include, in YYYY-MM-DD format. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Analytics Credit History **Slug:** `LEADMAGIC_GET_ANALYTICS_CREDIT_HISTORY` Get LeadMagic credit consumption history with a daily breakdown. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `days` | integer | No | Number of days to include, from 1 through 90. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Analytics Daily Metrics **Slug:** `LEADMAGIC_GET_ANALYTICS_DAILY_METRICS` Get documented daily request, credit, latency, and error metrics for the last 1 to 90 days. This free analytics route was not individually live-probed during the build. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `days` | integer | No | Number of days to include, from 1 through 90. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Analytics Day Breakdown **Slug:** `LEADMAGIC_GET_ANALYTICS_DAY_BREAKDOWN` Get the documented per-product request and credit breakdown for one date. This free analytics route was not individually live-probed during the build. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `date` | string | Yes | Date to inspect, in YYYY-MM-DD format. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Analytics Products **Slug:** `LEADMAGIC_GET_ANALYTICS_PRODUCTS` Get per-product LeadMagic usage with request, credit, and success metrics. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `days` | integer | No | Number of days to include, from 1 through 90. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Analytics Usage **Slug:** `LEADMAGIC_GET_ANALYTICS_USAGE` Get daily LeadMagic usage with request, credit, and chargeable-rate totals. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `days` | integer | No | Number of days to include, from 1 through 90. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get B2B Ad Details V1 **Slug:** `LEADMAGIC_GET_B2B_AD_DETAILS_V1` Get full details for a specific B2B ad from its library URL, detail path, or numeric ID. A successful full-details lookup costs exactly 2 credits; use credits_consumed as finalized spend. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ad_url` | string | Yes | B2B ad library URL, /ad-library/detail/{id} path, or numeric ad ID. A successful detail lookup costs exactly 2 credits. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get B2B Profile From Email **Slug:** `LEADMAGIC_GET_B2B_PROFILE_FROM_EMAIL` Find one person's professional profile from a supplied work or personal email. A found complete profile costs 10 credits. Email addresses and matched profile data are personal data; submit and use them only for a lawful, authorized purpose. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `work_email` | string | No | A known work email for the person. | | `personal_email` | string | No | A known personal email for the person. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get B2B Profile From Profile URL **Slug:** `LEADMAGIC_GET_B2B_PROFILE_FROM_PROFILE_URL` Retrieve one person's professional profile, including employment, education, certifications, and honors, from a profile URL or slug. A found full profile costs 1 credit. Returned profile data is personal data; use it only for a lawful, authorized purpose. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `profile_url` | string | Yes | The person's professional profile URL or profile slug. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Batch **Slug:** `LEADMAGIC_GET_BATCH` Read status, progress, cost, and metadata for a mixed-product batch by its exact batch identifier. A missing synthetic identifier safely returns not found and does not mutate or spend credits. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `batch_id` | string | Yes | Batch identifier returned by mixed-product batch submission. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Batch Campaign Metrics **Slug:** `LEADMAGIC_GET_BATCH_CAMPAIGN_METRICS` Read aggregate usage and success metrics for a batch campaign. A syntactically valid missing identifier can be used for a safe, non-mutating not-found check. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `campaign_id` | string | Yes | Campaign identifier used to group related batches. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Batch Client Metrics **Slug:** `LEADMAGIC_GET_BATCH_CLIENT_METRICS` Read aggregate batch usage and success metrics for one client UUID. An all-zero missing UUID is safe for a non-mutating not-found check. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `client_id` | string | Yes | UUID of the batch client whose aggregate metrics should be returned. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Bulk Capabilities **Slug:** `LEADMAGIC_GET_BULK_CAPABILITIES` Return the current bulk submission limits and supported operational features in a stable agent-facing shape. Service-internal host and deployment metadata are intentionally omitted. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Bulk Job **Slug:** `LEADMAGIC_GET_BULK_JOB` Read status, progress, timestamps, and finalized credit usage for one bulk job. Pass a jobId captured from the same owned submission workflow; do not inspect an unrelated workspace job. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `job_id` | string | Yes | UUID captured from a bulk job created by this workflow. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Bulk Job Progress **Slug:** `LEADMAGIC_GET_BULK_JOB_PROGRESS` Return LeadMagic's compact progress snapshot for frequent polling of one bulk job owned by the connected workspace. This read does not start, stop, or restart processing. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `token` | string | No | Signed progress token returned when this bulk job was submitted. | | `job_id` | string | Yes | UUID of a bulk job owned by the connected workspace, normally captured from Submit Bulk Job in the same workflow. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Company Funding V1 **Slug:** `LEADMAGIC_GET_COMPANY_FUNDING_V1` Call POST /v1/companies/company-funding to get complete funding history and related company intelligence by domain or name. A successful funding result costs 4 credits. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `company_name` | string | No | Company name. | | `company_domain` | string | No | Company domain, such as example.com. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Company Funding V3 Company Docs Alias **Slug:** `LEADMAGIC_GET_COMPANY_FUNDING_V3_COMPANY_DOCS_ALIAS` Call the distinct documented POST /v3/companies/company-funding alias. Prefer SEARCH_COMPANIES for new integrations. Returns one cursor-controlled page. This route remains ordinarily metered even when browsing routes are unmetered; LeadMagic does not state an exact alias-specific charge, so use credits_consumed as finalized spend. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum companies on this page (1-50). This does not fetch later pages. | | `query` | string | No | Free-text company search query. | | `cursor` | string | No | Opaque next_cursor from the previous response. Pass it unchanged; the original criteria and limit are restored safely. | | `domain` | string | No | Documented alias for company_domain. | | `offset` | integer | No | Legacy unstable offset. Prefer cursor pagination; use offset 0 when starting or continuing a cursor search. | | `website` | string | No | Company website URL or domain. | | `profile_url` | string | No | Professional company profile URL. | | `company_name` | string | No | Company name to look up or search. | | `linkedin_url` | string | No | Documented alias for a professional company profile URL. | | `company_domain` | string | No | Direct one-company lookup domain, such as example.com. | | `company_filters` | object | No | Typed company filters for identity, firmographics, geography, funding, contact coverage, web presence, and technologies. Unset fields are omitted. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Company Funding V3 Docs Alias **Slug:** `LEADMAGIC_GET_COMPANY_FUNDING_V3_DOCS_ALIAS` Call the distinct documented POST /v3/companies/funding alias. Prefer SEARCH_COMPANIES for new integrations. Returns one cursor-controlled page. This route remains ordinarily metered even when browsing routes are unmetered; LeadMagic does not state an exact alias-specific charge, so use credits_consumed as finalized spend. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum companies on this page (1-50). This does not fetch later pages. | | `query` | string | No | Free-text company search query. | | `cursor` | string | No | Opaque next_cursor from the previous response. Pass it unchanged; the original criteria and limit are restored safely. | | `domain` | string | No | Documented alias for company_domain. | | `offset` | integer | No | Legacy unstable offset. Prefer cursor pagination; use offset 0 when starting or continuing a cursor search. | | `website` | string | No | Company website URL or domain. | | `profile_url` | string | No | Professional company profile URL. | | `company_name` | string | No | Company name to look up or search. | | `linkedin_url` | string | No | Documented alias for a professional company profile URL. | | `company_domain` | string | No | Direct one-company lookup domain, such as example.com. | | `company_filters` | object | No | Typed company filters for identity, firmographics, geography, funding, contact coverage, web presence, and technologies. Unset fields are omitted. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Company Technographics V1 **Slug:** `LEADMAGIC_GET_COMPANY_TECHNOGRAPHICS_V1` Get a company's technology stack from its domain. A successful stack result costs 1 credit; use credits_consumed as finalized spend. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `company_domain` | string | Yes | Domain of the company whose technology stack should be analyzed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Credit Balance V1 **Slug:** `LEADMAGIC_GET_CREDIT_BALANCE_V1` Check the connected LeadMagic workspace's current credit balance for free. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Credit Budget Status **Slug:** `LEADMAGIC_GET_CREDIT_BUDGET_STATUS` Read current limits, remaining credits, and exceeded state for every LeadMagic credit budget. This does not reserve or consume credits. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Credit Service Health V1 Docs Only **Slug:** `LEADMAGIC_GET_CREDIT_SERVICE_HEALTH_V1_DOCS_ONLY` Validate the connected LeadMagic API key and check credit-service authentication status. This medium-confidence docs-only read has an undocumented response schema and billing behavior and was not live-probed. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Email Suppression List **Slug:** `LEADMAGIC_GET_EMAIL_SUPPRESSION_LIST` Return one offset-controlled page of details and irreversible SHA-256 email hashes for one owned suppression list. Use only the exact list_id captured in the same create lifecycle, never auto-fetch pages, and continue only with the returned next_offset. Hashes cannot be converted back to plaintext emails. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum email hashes to return in this page (1-1000). | | `offset` | integer | No | Zero-based hash offset. Continue only with next_offset from the prior response. | | `list_id` | string | Yes | Exact suppression-list identifier captured from Create Email Suppression List in the same owned lifecycle. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Job Board Stats V3 **Slug:** `LEADMAGIC_GET_JOB_BOARD_STATS_V3` Return the free job search dataset statistics through LeadMagic's exact job-board integration alias route. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Job Search Catalogs **Slug:** `LEADMAGIC_GET_JOB_SEARCH_CATALOGS` Return the free filter catalogs used by job search, including countries, regions, job types, industries, company types, and seniority values. This helper consumes 0 credits. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Job Search Dataset Stats V3 **Slug:** `LEADMAGIC_GET_JOB_SEARCH_DATASET_STATS_V3` Return free public coverage, freshness, and capability statistics for the LeadMagic Jobs Search index. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Search Stats **Slug:** `LEADMAGIC_GET_SEARCH_STATS` Return free cached coverage, capabilities, and top dimensions for selected LeadMagic search products. Requested product sections may be absent when unavailable. This helper costs 0 credits. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum top values per dimension (1-10). | | `products` | array | No | Search products whose stats to request. | | `sections` | array | No | Stat sections to request. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Batch Clients **Slug:** `LEADMAGIC_LIST_BATCH_CLIENTS` List existing organization-scoped client records used to segment batch work. This read does not create or modify clients. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Batch Client Webhooks **Slug:** `LEADMAGIC_LIST_BATCH_CLIENT_WEBHOOKS` List delivery webhooks configured for one batch client. This read does not create, change, or invoke webhooks. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `client_id` | string | Yes | UUID of the batch client whose delivery webhooks should be listed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Batches **Slug:** `LEADMAGIC_LIST_BATCHES` List one bounded page of mixed-product batches for the connected organization. Continue only with the returned next_offset; this tool never auto-fetches additional pages. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum batches to return (1-200). | | `offset` | integer | No | Zero-based result offset. Use next_offset from the prior response to continue. | | `status` | string | No | Filter batches by provider batch status. | | `product` | string | No | Filter batches by enrichment product. | | `client_id` | string | No | Filter batches by associated client identifier. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Bulk Job Errors **Slug:** `LEADMAGIC_LIST_BULK_JOB_ERRORS` Return one offset-controlled page of failed rows and error details for a bulk job owned by the connected workspace. This is read-only and never retries or restarts failed rows. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum failed rows to return in this page (1-1000). | | `job_id` | string | Yes | UUID of a bulk job owned by the connected workspace, normally captured from Submit Bulk Job in the same workflow. | | `offset` | integer | No | Zero-based failed-row offset for this page (0-1000000). | | `status` | string | No | Optional provider status value used to filter failed rows. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Bulk Job Events **Slug:** `LEADMAGIC_LIST_BULK_JOB_EVENTS` Return the append-only event log, newest first, for one bulk job owned by the connected workspace. Reading events does not alter the job lifecycle. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum append-only events to return, newest first (1-2000). | | `job_id` | string | Yes | UUID of a bulk job owned by the connected workspace, normally captured from Submit Bulk Job in the same workflow. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Bulk Job Results **Slug:** `LEADMAGIC_LIST_BULK_JOB_RESULTS` Return one bounded offset page of row-level JSON results for an owned bulk job. Use only a jobId captured from the same submission chain and pass next_offset back explicitly to continue; this tool never auto-fetches all rows. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum rows in this page (1-1000). | | `job_id` | string | Yes | UUID captured from a bulk job created by this workflow. | | `offset` | integer | No | Zero-based row offset for this page. | | `status` | string | No | Optional row-status filter. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Bulk Jobs **Slug:** `LEADMAGIC_LIST_BULK_JOBS` Return one bounded offset page of bulk jobs owned by the connected account, newest first. Use next_offset to continue; this action never auto-fetches pages. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Number of jobs in this page (1-200). | | `offset` | integer | No | Number of jobs to skip (0-10000). Pass next_offset to continue. | | `status` | string | No | Filter jobs by current status. | | `product` | string | No | Filter jobs by enrichment product. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Credit Budgets **Slug:** `LEADMAGIC_LIST_CREDIT_BUDGETS` List all persistent credit budgets configured for the connected LeadMagic workspace, including identifiers needed for owned-budget lifecycle operations. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Email Suppression Lists **Slug:** `LEADMAGIC_LIST_EMAIL_SUPPRESSION_LISTS` Read all suppression-list summaries for the connected workspace. This tool is for discovery only: never pass an ID from this result to a mutation or deletion; lifecycle writes must use the exact ID captured from a list created by that workflow. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List External Batch Providers **Slug:** `LEADMAGIC_LIST_EXTERNAL_BATCH_PROVIDERS` List organization-level external enrichment provider configurations. LeadMagic redacts stored credentials from this read. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Job Company Types V1 **Slug:** `LEADMAGIC_LIST_JOB_COMPANY_TYPES_V1` List the company type IDs accepted by the legacy V1 Jobs Finder API. No route-specific charge is documented; reported finalized spend should be treated as authoritative. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Job Countries V1 **Slug:** `LEADMAGIC_LIST_JOB_COUNTRIES_V1` List the free country codes accepted by the legacy V1 Jobs Finder API. Use V3 catalogs or locations for V3 job search. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Job Industries V1 **Slug:** `LEADMAGIC_LIST_JOB_INDUSTRIES_V1` List the industry IDs accepted by the legacy V1 Jobs Finder API. No route-specific charge is documented; reported finalized spend should be treated as authoritative. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Job Occupation Taxonomy V3 **Slug:** `LEADMAGIC_LIST_JOB_OCCUPATION_TAXONOMY_V3` Autocomplete LeadMagic's broad-to-specific occupation taxonomy and return canonical IDs, labels, levels, and paths. This helper is free and consumes 0 credits. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `level` | string ("level1" | "level2" | "level3") | No | Restrict results to a broad family, category, or normalized title level. | | `limit` | integer | No | Number of taxonomy entries to return. | | `query` | string | No | Free-text occupation query. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Job Regions V1 **Slug:** `LEADMAGIC_LIST_JOB_REGIONS_V1` List the free region IDs accepted by the legacy V1 Jobs Finder API. Use the exact returned IDs with V1 job searches. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Job Search Company Suggestions V3 **Slug:** `LEADMAGIC_LIST_JOB_SEARCH_COMPANY_SUGGESTIONS_V3` Autocomplete companies or resolve an exact domain into canonical company IDs and card data for Job Search filters. This helper is free and consumes 0 credits. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Number of company candidates to return. | | `query` | string | No | Free-text company name or domain to match. | | `domain` | string | No | Exact company domain to look up. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Job Search Location Suggestions V3 **Slug:** `LEADMAGIC_LIST_JOB_SEARCH_LOCATION_SUGGESTIONS_V3` Autocomplete countries, regions, states, and cities into canonical IDs for exact Job Search geo filters. This helper is free and consumes 0 credits. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string ("country" | "region" | "state" | "city") | No | Location type to search: country, region, state, or city. | | `limit` | integer | No | Number of location candidates to return. | | `query` | string | No | Free-text country, region, state, or city query. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Job Search Role Suggestions V3 **Slug:** `LEADMAGIC_LIST_JOB_SEARCH_ROLE_SUGGESTIONS_V3` Autocomplete role names into canonical occupation taxonomy IDs for Job Search filters. This helper is free and consumes 0 credits. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Number of role candidates to return. | | `query` | string | No | Free-text role query. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Job Search Tag Suggestions V3 **Slug:** `LEADMAGIC_LIST_JOB_SEARCH_TAG_SUGGESTIONS_V3` Autocomplete normalized job tags with tag-type and occupation taxonomy metadata for Job Search filters. This helper is free and consumes 0 credits. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Number of tag candidates to return. | | `query` | string | No | Free-text tag query, such as a tool, platform, or skill prefix. | | `tag_type` | integer | No | Optional tag-type ID used to restrict suggestions. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Job Search Title Suggestions V3 **Slug:** `LEADMAGIC_LIST_JOB_SEARCH_TITLE_SUGGESTIONS_V3` Autocomplete searchable job title phrases with occupation taxonomy metadata for Job Search filters. This helper is free and consumes 0 credits. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Number of title candidates to return. | | `query` | string | No | Free-text job title query. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Job Types V1 **Slug:** `LEADMAGIC_LIST_JOB_TYPES_V1` List the job type IDs accepted by the legacy V1 Jobs Finder API. No route-specific charge is documented; reported finalized spend should be treated as authoritative. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Lookup Company Domain V3 Docs Alias **Slug:** `LEADMAGIC_LOOKUP_COMPANY_DOMAIN_V3_DOCS_ALIAS` Call the distinct documented POST /v3/companies/domain-lookup alias. Prefer SEARCH_COMPANIES for new integrations. Returns one cursor-controlled page. This route remains ordinarily metered even when browsing routes are unmetered; LeadMagic does not state an exact alias-specific charge, so use credits_consumed as finalized spend. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum companies on this page (1-50). This does not fetch later pages. | | `query` | string | No | Free-text company search query. | | `cursor` | string | No | Opaque next_cursor from the previous response. Pass it unchanged; the original criteria and limit are restored safely. | | `domain` | string | No | Documented alias for company_domain. | | `offset` | integer | No | Legacy unstable offset. Prefer cursor pagination; use offset 0 when starting or continuing a cursor search. | | `website` | string | No | Company website URL or domain. | | `profile_url` | string | No | Professional company profile URL. | | `company_name` | string | No | Company name to look up or search. | | `linkedin_url` | string | No | Documented alias for a professional company profile URL. | | `company_domain` | string | No | Direct one-company lookup domain, such as example.com. | | `company_filters` | object | No | Typed company filters for identity, firmographics, geography, funding, contact coverage, web presence, and technologies. Unset fields are omitted. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Lookup Company V3 Docs Alias **Slug:** `LEADMAGIC_LOOKUP_COMPANY_V3_DOCS_ALIAS` Call the distinct documented POST /v3/companies/lookup alias. Prefer SEARCH_COMPANIES for new integrations. Returns one cursor-controlled page. This route remains ordinarily metered even when browsing routes are unmetered; LeadMagic does not state an exact alias-specific charge, so use credits_consumed as finalized spend. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum companies on this page (1-50). This does not fetch later pages. | | `query` | string | No | Free-text company search query. | | `cursor` | string | No | Opaque next_cursor from the previous response. Pass it unchanged; the original criteria and limit are restored safely. | | `domain` | string | No | Documented alias for company_domain. | | `offset` | integer | No | Legacy unstable offset. Prefer cursor pagination; use offset 0 when starting or continuing a cursor search. | | `website` | string | No | Company website URL or domain. | | `profile_url` | string | No | Professional company profile URL. | | `company_name` | string | No | Company name to look up or search. | | `linkedin_url` | string | No | Documented alias for a professional company profile URL. | | `company_domain` | string | No | Direct one-company lookup domain, such as example.com. | | `company_filters` | object | No | Typed company filters for identity, firmographics, geography, funding, contact coverage, web presence, and technologies. Unset fields are omitted. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Pause Bulk Job **Slug:** `LEADMAGIC_PAUSE_BULK_JOB` Pause a queued or running LeadMagic bulk job. This mutates processing state but is reversible with Resume Bulk Job. Use only a job ID owned by the connected workspace and intentionally selected for this lifecycle workflow. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `job_id` | string | Yes | UUID of a queued or running bulk job created and owned by the connected workspace. Never pause a pre-existing job selected from an unrelated list. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Preview Mixed Batch Cost **Slug:** `LEADMAGIC_PREVIEW_MIXED_BATCH_COST` Estimate the maximum credit cost and budget impact of an exact mixed-product batch payload. This is a free dry run: it does not submit work, reserve credits, or consume credits. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `items` | array | Yes | One to 10,000 batch items to estimate without submitting work. | | `metadata` | object | No | Optional metadata for the whole preview. | | `client_id` | string | No | Optional client identifier for the whole preview. | | `client_name` | string | No | Optional client name for the whole preview. | | `budget_user_id` | string | No | User ID whose configured credit budget should be checked by the preview. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Refresh Credit Cache V1 Docs Only **Slug:** `LEADMAGIC_REFRESH_CREDIT_CACHE_V1_DOCS_ONLY` Force LeadMagic to refresh the connected workspace's credit cache from its database. This medium-confidence docs-only POST updates cached account state; its response schema and billing behavior are undocumented and it was not live-probed. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove Emails From Suppression List **Slug:** `LEADMAGIC_REMOVE_EMAILS_FROM_SUPPRESSION_LIST` Irreversibly remove specific email suppressions from one owned list, allowing those addresses to be processed again. Use only the exact list_id captured in the same create lifecycle and the exact lifecycle-owned plaintext addresses previously added; never alter a pre-existing list. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `emails` | array | Yes | Non-empty plaintext email list to unsuppress. Each address must be the exact lifecycle-owned value previously added to this list. | | `list_id` | string | Yes | Exact suppression-list identifier captured from Create Email Suppression List in the same owned lifecycle. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Resolve Job Search Filters V3 **Slug:** `LEADMAGIC_RESOLVE_JOB_SEARCH_FILTERS_V3` Resolve friendly job-search companies, tags, occupation taxonomy, locations, and titles into canonical values. This helper returns no jobs and costs 0 credits. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tags` | object | No | Job tags to resolve. | | `titles` | object | No | Title filters to resolve. | | `location` | object | No | Location filters to resolve. | | `companies` | object | No | Company filters to resolve. | | `occupation_taxonomy` | object | No | Occupation taxonomy filters sent under the exact occupationTaxonomy key. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Restart Bulk Job **Slug:** `LEADMAGIC_RESTART_BULK_JOB` Destructively restart a LeadMagic bulk job in full, for failed rows only, or from a zero-based row or shard. This irreversible lifecycle operation can repeat work and consume additional credits. Use only an intentionally selected job owned by the connected workspace; inspect its status and errors first. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `mode` | string ("full" | "failed_only" | "from_row" | "from_shard") | No | Rows to reprocess: full, failed_only, from_row, or from_shard. Restarting can repeat enrichment work and consume additional credits. | | `job_id` | string | Yes | UUID of a bulk job created and owned by the connected workspace. Never restart a pre-existing job selected from an unrelated list. | | `start_row_index` | integer | No | Zero-based row index; required only when mode is from_row. | | `start_shard_index` | integer | No | Zero-based shard index; required only when mode is from_shard. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Resume Bulk Job **Slug:** `LEADMAGIC_RESUME_BULK_JOB` Resume a paused LeadMagic bulk job. This mutates processing state and may continue the job's existing credit-consuming work. Use only a job ID owned by the connected workspace and intentionally paused in this workflow. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `job_id` | string | Yes | UUID of a paused bulk job created and owned by the connected workspace. Never resume a pre-existing job selected from an unrelated list. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Review Bulk Job **Slug:** `LEADMAGIC_REVIEW_BULK_JOB` Resume or irreversibly cancel an owned bulk job. Use only a jobId captured from the same submission chain, choose a state-valid transition, and never mutate a pre-existing job discovered by listing workspace jobs. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `action` | string ("approve" | "reject") | Yes | approve resumes a paused job; reject cancels a queued or processing job. | | `job_id` | string | Yes | UUID captured from a bulk job created by this workflow. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search B2B Ads V1 **Slug:** `LEADMAGIC_SEARCH_B2B_ADS_V1` Search for B2B ads by company domain or name. The exact charge is 1 base credit plus 1 credit per returned ad, with a minimum of 1 credit. Set limit to bound the per-ad portion; use credits_consumed as finalized spend. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum ads to return (1-100). This caps the 1-credit-per-ad portion of spend; the 1 base credit per search still applies. Defaults to 1. | | `company_name` | string | No | Company name to search. Provide this or company_domain. | | `company_domain` | string | No | Company domain to search. Provide this or company_name. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Companies **Slug:** `LEADMAGIC_SEARCH_COMPANIES` Call the canonical POST /v3/companies/search route to search or look up companies by domain, name, website, professional profile URL, or company filters and return one cursor-controlled page. On the connected Starter plan, each search request costs 1 credit; eligible higher plans may be unmetered. The page limit is capped at 50. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum companies in this page (1-50). On the connected Starter plan, the search request costs 1 credit regardless of page size. | | `query` | string | No | A free-text company search query. | | `cursor` | string | No | Opaque next_cursor from the previous response. Pass it unchanged; the original criteria and limit are retained by the cursor. | | `domain` | string | No | Alias for company_domain accepted by LeadMagic. | | `offset` | integer | No | Legacy result offset. Prefer cursor pagination; restart at offset 0 to obtain a stable cursor. | | `website` | string | No | A company website URL or domain. | | `profile_url` | string | No | A professional company profile URL. | | `company_name` | string | No | A company name to look up or search. | | `linkedin_url` | string | No | Alias for profile_url accepted by LeadMagic. | | `company_domain` | string | No | A bare domain for a direct company lookup. | | `company_filters` | object | No | Structured filters for company identity, firmographics, geography, funding, contact coverage, web presence, and technologies. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Companies V1 Legacy Docs Alias **Slug:** `LEADMAGIC_SEARCH_COMPANIES_V1_LEGACY_DOCS_ALIAS` Call the distinct legacy compatibility route POST /v1/companies/search. Prefer SEARCH_COMPANIES for new integrations. Returns one cursor-controlled page. Billing is 1 credit per search on metered plans and unmetered on eligible Search RPS plans; credits_consumed is the finalized spend. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum companies on this page (1-50). This does not fetch later pages. | | `query` | string | No | Free-text company search query. | | `cursor` | string | No | Opaque next_cursor from the previous response. Pass it unchanged; the original criteria and limit are restored safely. | | `domain` | string | No | Documented alias for company_domain. | | `offset` | integer | No | Legacy unstable offset. Prefer cursor pagination; use offset 0 when starting or continuing a cursor search. | | `website` | string | No | Company website URL or domain. | | `profile_url` | string | No | Professional company profile URL. | | `company_name` | string | No | Company name to look up or search. | | `linkedin_url` | string | No | Documented alias for a professional company profile URL. | | `company_domain` | string | No | Direct one-company lookup domain, such as example.com. | | `company_filters` | object | No | Typed company filters for identity, firmographics, geography, funding, contact coverage, web presence, and technologies. Unset fields are omitted. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Companies V3 Company Hyphenated Docs Alias **Slug:** `LEADMAGIC_SEARCH_COMPANIES_V3_COMPANY_HYPHENATED_DOCS_ALIAS` Call the distinct documented POST /v3/companies/company-search alias. Prefer SEARCH_COMPANIES for new integrations. Returns one cursor-controlled page. Billing is 1 credit per search on metered plans and unmetered on eligible Search RPS plans; credits_consumed is the finalized spend. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum companies on this page (1-50). This does not fetch later pages. | | `query` | string | No | Free-text company search query. | | `cursor` | string | No | Opaque next_cursor from the previous response. Pass it unchanged; the original criteria and limit are restored safely. | | `domain` | string | No | Documented alias for company_domain. | | `offset` | integer | No | Legacy unstable offset. Prefer cursor pagination; use offset 0 when starting or continuing a cursor search. | | `website` | string | No | Company website URL or domain. | | `profile_url` | string | No | Professional company profile URL. | | `company_name` | string | No | Company name to look up or search. | | `linkedin_url` | string | No | Documented alias for a professional company profile URL. | | `company_domain` | string | No | Direct one-company lookup domain, such as example.com. | | `company_filters` | object | No | Typed company filters for identity, firmographics, geography, funding, contact coverage, web presence, and technologies. Unset fields are omitted. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Google Ads V1 **Slug:** `LEADMAGIC_SEARCH_GOOGLE_ADS_V1` Search for Google ads run by a company. Each returned ad costs exactly 1 credit and no results are free. The limit defaults to 1 to bound spend; use credits_consumed as finalized spend. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum ads to return (1-100). Each returned ad costs 1 credit, so this caps request spend. Defaults to 1. | | `company_name` | string | No | Company name to search. Provide this or company_domain. | | `company_domain` | string | No | Company domain to search. Provide this or company_name. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Jobs **Slug:** `LEADMAGIC_SEARCH_JOBS` Call the canonical POST /v3/jobs/search route to search by title, company, location, taxonomy, tags, salary, seniority, date, and work arrangement, returning one cursor-controlled page. On the connected Starter plan, each returned job costs 1 credit and zero-result pages are free. Eligible higher plans may be unmetered. The page limit is capped at 5, for a maximum exposure of 5 credits per call. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `mode` | string ("fast" | "deep") | No | Use fast for normal browsing; deep enables broader text matching. | | `tags` | object | No | Job tag criteria using names or canonical IDs. | | `limit` | integer | No | Maximum jobs in this page (1-5). On the connected Starter plan, each returned job costs 1 credit, so the maximum exposure is 5 credits. | | `cursor` | string | No | Opaque next_cursor from the previous response. Pass it unchanged; the original filters and limit are retained by the cursor. | | `salary` | object | No | Normalized annual salary bounds in USD. | | `titles` | object | No | Title criteria with include and exclude terms and optional vector matching. | | `location` | object | No | Location criteria using country, region, state, and city values. | | `companies` | object | No | Company criteria using names, domains, or canonical numeric IDs. | | `seniority` | array | No | Seniority labels to include, such as EN, MI, SE, or EX. | | `remote_only` | boolean | No | When true, require jobs marked as supporting remote work. | | `posted_after` | string | No | Only include jobs posted on or after this YYYY-MM-DD date. | | `posted_before` | string | No | Only include jobs posted on or before this YYYY-MM-DD date. | | `posted_within_days` | integer | No | Only include jobs posted within the last N days. | | `include_description` | boolean | No | Include job description text; this can increase latency and response size. | | `occupation_taxonomy` | object | No | Occupation taxonomy filters grouped into level1, level2, and level3. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Jobs V1 Legacy Docs Alias **Slug:** `LEADMAGIC_SEARCH_JOBS_V1_LEGACY_DOCS_ALIAS` Call the distinct legacy compatibility route POST /v1/jobs/search; prefer POST /v3/jobs/search for new integrations. Returns one cursor page. Billing is 1 credit per search on metered plans and unmetered on eligible Search RPS plans. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `mode` | string ("fast" | "deep") | No | fast browses normally; deep enables broader text matching. | | `tags` | object | No | Job tag filters. | | `limit` | integer | No | Maximum jobs in this page (1-50). | | `cursor` | string | No | Opaque next_cursor from the previous page; pass it unchanged. | | `salary` | object | No | Salary filters in USD. | | `titles` | object | No | Job title filters. | | `location` | object | No | Location filters. | | `companies` | object | No | Company filters. | | `languages` | array | No | Job languages to include. | | `seniority` | array | No | Seniority codes to include. | | `has_remote` | boolean | No | Whether to require jobs supporting remote work. | | `total_mode` | string ("none" | "capped" | "exact") | No | Count mode for the result total. | | `auto_resolve` | boolean | No | Resolve friendly filter values to canonical IDs. | | `industry_ids` | array | No | Industry IDs from the V1 industry catalog. | | `job_type_ids` | array | No | Job type IDs from the V1 job type catalog. | | `posted_after` | string | No | Only include jobs posted on or after this date. | | `posted_before` | string | No | Only include jobs posted on or before this date. | | `posted_within` | integer | No | Only include jobs posted within the last N days. | | `include_facets` | boolean | No | Include facet metadata; this may increase response time. | | `company_type_ids` | array | No | Company type IDs from the V1 company type catalog. | | `company_size_codes` | array | No | Company size codes to include. | | `include_description` | boolean | No | Include job descriptions; this may increase response time. | | `occupation_taxonomy` | object | No | Occupation taxonomy filters. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Jobs V2 Legacy Docs Alias **Slug:** `LEADMAGIC_SEARCH_JOBS_V2_LEGACY_DOCS_ALIAS` Call the distinct legacy compatibility route POST /v2/jobs/search; prefer POST /v3/jobs/search for new integrations. Returns one cursor page. Billing is 1 credit per search on metered plans and unmetered on eligible Search RPS plans. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `mode` | string ("fast" | "deep") | No | fast browses normally; deep enables broader text matching. | | `tags` | object | No | Job tag filters. | | `limit` | integer | No | Maximum jobs in this page (1-50). | | `cursor` | string | No | Opaque next_cursor from the previous page; pass it unchanged. | | `salary` | object | No | Salary filters in USD. | | `titles` | object | No | Job title filters. | | `location` | object | No | Location filters. | | `companies` | object | No | Company filters. | | `languages` | array | No | Job languages to include. | | `seniority` | array | No | Seniority codes to include. | | `has_remote` | boolean | No | Whether to require jobs supporting remote work. | | `total_mode` | string ("none" | "capped" | "exact") | No | Count mode for the result total. | | `auto_resolve` | boolean | No | Resolve friendly filter values to canonical IDs. | | `industry_ids` | array | No | Industry IDs from the V1 industry catalog. | | `job_type_ids` | array | No | Job type IDs from the V1 job type catalog. | | `posted_after` | string | No | Only include jobs posted on or after this date. | | `posted_before` | string | No | Only include jobs posted on or before this date. | | `posted_within` | integer | No | Only include jobs posted within the last N days. | | `include_facets` | boolean | No | Include facet metadata; this may increase response time. | | `company_type_ids` | array | No | Company type IDs from the V1 company type catalog. | | `company_size_codes` | array | No | Company size codes to include. | | `include_description` | boolean | No | Include job descriptions; this may increase response time. | | `occupation_taxonomy` | object | No | Occupation taxonomy filters. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Jobs V3 Hyphenated OpenAPI Alias **Slug:** `LEADMAGIC_SEARCH_JOBS_V3_HYPHENATED_OPENAPI_ALIAS` Search the distinct documented POST /v3/jobs-search alias and return one cursor-controlled page. On metered plans, each returned job can cost 1 credit; the page limit is capped at 5 credits of result exposure. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `mode` | string ("fast" | "deep") | No | Search execution mode. | | `tags` | object | No | Tag filter criteria. | | `limit` | integer | No | Jobs in this page (1-5). Each returned job can cost 1 credit. | | `cursor` | string | No | Opaque next_cursor from the previous page; pass it unchanged. | | `titles` | object | No | Title search criteria. | | `location` | object | No | Country filter criteria. | | `total_mode` | string ("none" | "capped" | "exact") | No | Count mode sent as the exact totalMode body key. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Jobs V3 Singular Docs Alias **Slug:** `LEADMAGIC_SEARCH_JOBS_V3_SINGULAR_DOCS_ALIAS` Call the distinct documented compatibility route POST /v3/job-search; prefer POST /v3/jobs/search for new integrations. Returns one cursor page. Billing is 1 credit per search on metered plans and unmetered on eligible Search RPS plans. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `mode` | string ("fast" | "deep") | No | fast browses normally; deep enables broader text matching. | | `tags` | object | No | Job tag filters. | | `limit` | integer | No | Maximum jobs in this page (1-50). | | `cursor` | string | No | Opaque next_cursor from the previous page; pass it unchanged. | | `salary` | object | No | Salary filters in USD. | | `titles` | object | No | Job title filters. | | `location` | object | No | Location filters. | | `companies` | object | No | Company filters. | | `languages` | array | No | Job languages to include. | | `seniority` | array | No | Seniority codes to include. | | `has_remote` | boolean | No | Whether to require jobs supporting remote work. | | `total_mode` | string ("none" | "capped" | "exact") | No | Count mode for the result total. | | `auto_resolve` | boolean | No | Resolve friendly filter values to canonical IDs. | | `industry_ids` | array | No | Industry IDs from the V1 industry catalog. | | `job_type_ids` | array | No | Job type IDs from the V1 job type catalog. | | `posted_after` | string | No | Only include jobs posted on or after this date. | | `posted_before` | string | No | Only include jobs posted on or before this date. | | `posted_within` | integer | No | Only include jobs posted within the last N days. | | `include_facets` | boolean | No | Include facet metadata; this may increase response time. | | `company_type_ids` | array | No | Company type IDs from the V1 company type catalog. | | `company_size_codes` | array | No | Company size codes to include. | | `include_description` | boolean | No | Include job descriptions; this may increase response time. | | `occupation_taxonomy` | object | No | Occupation taxonomy filters. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Meta Ads V1 **Slug:** `LEADMAGIC_SEARCH_META_ADS_V1` Search for Meta ads by company domain or name. Each returned ad costs exactly 1 credit and no results are free. The limit defaults to 1 to bound spend; use credits_consumed as finalized spend. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum ads to return (1-100). Each returned ad costs 1 credit, so this caps request spend. Defaults to 1. | | `company_name` | string | No | Company name to search. Provide this or company_domain. | | `company_domain` | string | No | Company domain to search. Provide this or company_name. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search People **Slug:** `LEADMAGIC_SEARCH_PEOPLE` Call the canonical POST /v3/people/search route to search by company, title, role, free text, and contact availability, returning one cursor-controlled page without raw email or mobile details. On the connected Starter plan, each returned person costs 1 credit; zero results are free. The maximum base exposure is 10 credits per call. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum people in this page (1-10). Each returned person costs 1 credit on the connected Starter plan. | | `query` | string | No | Free-text person or title query. | | `roles` | array | No | Role or function labels to match. | | `cursor` | string | No | Opaque next_cursor from the previous response. Pass it unchanged; the original filters and limit are retained by the cursor. | | `job_titles` | array | No | Job titles to match; values within this list are alternatives. | | `company_name` | string | No | Limit results to a company name when the domain is unknown. | | `company_domain` | string | No | Limit results to a company domain. | | `require_email_available` | boolean | No | Only return people for whom email availability is known; this does not unlock or return the raw email. | | `require_mobile_available` | boolean | No | Only return people for whom mobile availability is known; this does not unlock or return the raw number. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search People V1 Legacy Docs Alias **Slug:** `LEADMAGIC_SEARCH_PEOPLE_V1_LEGACY_DOCS_ALIAS` Call the distinct legacy compatibility route POST /v1/people/search; prefer the canonical V3 route for new integrations. Returns one base-only cursor page and never requests raw contact details. Each returned person costs 1 credit on metered plans; zero results are free; maximum base exposure is 10 credits. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum people in this page (1-10); each returned person costs 1 credit on metered plans. | | `query` | string | No | Free-text people or title query. | | `roles` | array | No | Role or function labels to match. | | `title` | string | No | Single title filter. | | `cursor` | string | No | Opaque continuation cursor; pass it unchanged without repeating filters. | | `titles` | array | No | Job titles to match as alternatives. | | `channels` | array | No | Legacy contactability availability requirements. | | `job_title` | string | No | Legacy single job-title filter. | | `company_name` | string | No | Company name search anchor. | | `linkedin_url` | string | No | B2B company profile URL or slug search anchor. | | `channel_match` | string ("any" | "all") | No | Whether any or all requested channels must be available. | | `company_domain` | string | No | Company domain search anchor. | | `people_filters` | object | No | People filters; list values are ORed and different keys are ANDed. | | `required_email` | boolean | No | Require known email availability without returning the raw email. | | `company_filters` | object | No | Criteria-based company search anchor using Company Search filters. | | `include_company` | boolean | No | Include base company data with each person. | | `required_mobile` | boolean | No | Require known mobile availability without returning the raw number. | | `include_domain_intel` | boolean | No | Include base domain intelligence with each person. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search People V2 Legacy Docs Alias **Slug:** `LEADMAGIC_SEARCH_PEOPLE_V2_LEGACY_DOCS_ALIAS` Call the distinct legacy compatibility route POST /v2/people/search; prefer the canonical V3 route for new integrations. Returns one base-only cursor page and never requests raw contact details. Each returned person costs 1 credit on metered plans; zero results are free; maximum base exposure is 10 credits. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum people in this page (1-10); each returned person costs 1 credit on metered plans. | | `query` | string | No | Free-text people or title query. | | `roles` | array | No | Role or function labels to match. | | `title` | string | No | Single title filter. | | `cursor` | string | No | Opaque continuation cursor; pass it unchanged without repeating filters. | | `titles` | array | No | Job titles to match as alternatives. | | `channels` | array | No | Legacy contactability availability requirements. | | `job_title` | string | No | Legacy single job-title filter. | | `company_name` | string | No | Company name search anchor. | | `linkedin_url` | string | No | B2B company profile URL or slug search anchor. | | `channel_match` | string ("any" | "all") | No | Whether any or all requested channels must be available. | | `company_domain` | string | No | Company domain search anchor. | | `people_filters` | object | No | People filters; list values are ORed and different keys are ANDed. | | `required_email` | boolean | No | Require known email availability without returning the raw email. | | `company_filters` | object | No | Criteria-based company search anchor using Company Search filters. | | `include_company` | boolean | No | Include base company data with each person. | | `required_mobile` | boolean | No | Require known mobile availability without returning the raw number. | | `include_domain_intel` | boolean | No | Include base domain intelligence with each person. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search People V3 By Title Docs Alias **Slug:** `LEADMAGIC_SEARCH_PEOPLE_V3_BY_TITLE_DOCS_ALIAS` Call the distinct compatibility route POST /v3/people/by-title; prefer the canonical route for new integrations. Returns one base-only cursor page and never requests raw contact details. Each returned person costs 1 credit on metered plans; zero results are free; maximum base exposure is 10 credits. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum people in this page (1-10); each returned person costs 1 credit on metered plans. | | `query` | string | No | Free-text people or title query. | | `roles` | array | No | Role or function labels to match. | | `title` | string | No | Single title filter. | | `cursor` | string | No | Opaque continuation cursor; pass it unchanged without repeating filters. | | `titles` | array | No | Job titles to match as alternatives. | | `channels` | array | No | Legacy contactability availability requirements. | | `job_title` | string | No | Legacy single job-title filter. | | `company_name` | string | No | Company name search anchor. | | `linkedin_url` | string | No | B2B company profile URL or slug search anchor. | | `channel_match` | string ("any" | "all") | No | Whether any or all requested channels must be available. | | `company_domain` | string | No | Company domain search anchor. | | `people_filters` | object | No | People filters; list values are ORed and different keys are ANDed. | | `required_email` | boolean | No | Require known email availability without returning the raw email. | | `company_filters` | object | No | Criteria-based company search anchor using Company Search filters. | | `include_company` | boolean | No | Include base company data with each person. | | `required_mobile` | boolean | No | Require known mobile availability without returning the raw number. | | `include_domain_intel` | boolean | No | Include base domain intelligence with each person. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search People V3 Company Docs Alias **Slug:** `LEADMAGIC_SEARCH_PEOPLE_V3_COMPANY_DOCS_ALIAS` Call the distinct documented POST /v3/people/company-search alias. Prefer SEARCH_PEOPLE for new integrations. Returns one cursor page without raw contacts. Each returned person costs 1 base credit; zero results are free. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | People to return on this cursor page (1-10), at 1 base credit per result. | | `query` | string | No | Free-text people or title query. | | `roles` | array | No | Role or function labels to match. | | `title` | string | No | Single job title to match. | | `cursor` | string | No | Opaque next_cursor from the prior page. Pass unchanged; filters are retained. | | `titles` | array | No | Job titles to match as alternatives. | | `channels` | array | No | Legacy contact-availability requirements. | | `job_title` | string | No | Legacy single job-title filter. | | `company_name` | string | No | Company name to search. | | `linkedin_url` | string | No | Professional company profile URL or slug. | | `channel_match` | string ("any" | "all") | No | Whether any or all requested channels must be available. | | `company_domain` | string | No | Company domain to search. | | `people_filters` | object | No | People-level filters. Different keys are ANDed; array values are alternatives. | | `required_email` | boolean | No | Require known email availability; raw email is never unlocked. | | `company_filters` | object | No | Documented Company Search filters defining the company set. | | `include_company` | boolean | No | Include base company data with each person. | | `required_mobile` | boolean | No | Require known mobile availability; raw numbers are never unlocked. | | `include_domain_intel` | boolean | No | Include base domain intelligence with each person. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search People V3 Contacts By Title Docs Alias **Slug:** `LEADMAGIC_SEARCH_PEOPLE_V3_CONTACTS_BY_TITLE_DOCS_ALIAS` Call the distinct compatibility route POST /v3/people/contacts-by-title; prefer the canonical route for new integrations. Returns one base-only cursor page and never requests raw contact details. Each returned person costs 1 credit on metered plans; zero results are free; maximum base exposure is 10 credits. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum people in this page (1-10); each returned person costs 1 credit on metered plans. | | `query` | string | No | Free-text people or title query. | | `roles` | array | No | Role or function labels to match. | | `title` | string | No | Single title filter. | | `cursor` | string | No | Opaque continuation cursor; pass it unchanged without repeating filters. | | `titles` | array | No | Job titles to match as alternatives. | | `channels` | array | No | Legacy contactability availability requirements. | | `job_title` | string | No | Legacy single job-title filter. | | `company_name` | string | No | Company name search anchor. | | `linkedin_url` | string | No | B2B company profile URL or slug search anchor. | | `channel_match` | string ("any" | "all") | No | Whether any or all requested channels must be available. | | `company_domain` | string | No | Company domain search anchor. | | `people_filters` | object | No | People filters; list values are ORed and different keys are ANDed. | | `required_email` | boolean | No | Require known email availability without returning the raw email. | | `company_filters` | object | No | Criteria-based company search anchor using Company Search filters. | | `include_company` | boolean | No | Include base company data with each person. | | `required_mobile` | boolean | No | Require known mobile availability without returning the raw number. | | `include_domain_intel` | boolean | No | Include base domain intelligence with each person. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search People V3 Employees Docs Alias **Slug:** `LEADMAGIC_SEARCH_PEOPLE_V3_EMPLOYEES_DOCS_ALIAS` Call the distinct compatibility route POST /v3/people/employees; prefer the canonical route for new integrations. Returns one base-only cursor page and never requests raw contact details. Each returned person costs 1 credit on metered plans; zero results are free; maximum base exposure is 10 credits. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum people in this page (1-10); each returned person costs 1 credit on metered plans. | | `query` | string | No | Free-text people or title query. | | `roles` | array | No | Role or function labels to match. | | `title` | string | No | Single title filter. | | `cursor` | string | No | Opaque continuation cursor; pass it unchanged without repeating filters. | | `titles` | array | No | Job titles to match as alternatives. | | `channels` | array | No | Legacy contactability availability requirements. | | `job_title` | string | No | Legacy single job-title filter. | | `company_name` | string | No | Company name search anchor. | | `linkedin_url` | string | No | B2B company profile URL or slug search anchor. | | `channel_match` | string ("any" | "all") | No | Whether any or all requested channels must be available. | | `company_domain` | string | No | Company domain search anchor. | | `people_filters` | object | No | People filters; list values are ORed and different keys are ANDed. | | `required_email` | boolean | No | Require known email availability without returning the raw email. | | `company_filters` | object | No | Criteria-based company search anchor using Company Search filters. | | `include_company` | boolean | No | Include base company data with each person. | | `required_mobile` | boolean | No | Require known mobile availability without returning the raw number. | | `include_domain_intel` | boolean | No | Include base domain intelligence with each person. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search People V3 Full Docs Alias **Slug:** `LEADMAGIC_SEARCH_PEOPLE_V3_FULL_DOCS_ALIAS` Call the distinct documented POST /v3/people/full-search alias. Prefer SEARCH_PEOPLE for new integrations. Despite its route name, raw contacts stay disabled. Each returned base person costs 1 credit; zero results are free. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | People to return on this cursor page (1-10), at 1 base credit per result. | | `query` | string | No | Free-text people or title query. | | `roles` | array | No | Role or function labels to match. | | `title` | string | No | Single job title to match. | | `cursor` | string | No | Opaque next_cursor from the prior page. Pass unchanged; filters are retained. | | `titles` | array | No | Job titles to match as alternatives. | | `channels` | array | No | Legacy contact-availability requirements. | | `job_title` | string | No | Legacy single job-title filter. | | `company_name` | string | No | Company name to search. | | `linkedin_url` | string | No | Professional company profile URL or slug. | | `channel_match` | string ("any" | "all") | No | Whether any or all requested channels must be available. | | `company_domain` | string | No | Company domain to search. | | `people_filters` | object | No | People-level filters. Different keys are ANDed; array values are alternatives. | | `required_email` | boolean | No | Require known email availability; raw email is never unlocked. | | `company_filters` | object | No | Documented Company Search filters defining the company set. | | `include_company` | boolean | No | Include base company data with each person. | | `required_mobile` | boolean | No | Require known mobile availability; raw numbers are never unlocked. | | `include_domain_intel` | boolean | No | Include base domain intelligence with each person. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search People V3 Icp Docs Alias **Slug:** `LEADMAGIC_SEARCH_PEOPLE_V3_ICP_DOCS_ALIAS` Call the distinct documented compatibility route POST /v3/people/icp-search; prefer POST /v3/people/search for new integrations. Returns one base-only cursor page and never requests raw contact details. Each returned person costs 1 credit on metered plans; zero results are free; maximum base exposure is 10 credits. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum people in this cursor page (1-10). Each returned person costs 1 credit on metered plans; zero-result pages are free. | | `query` | string | No | Free-text people or title query. | | `roles` | array | No | Role or function labels to match. | | `title` | string | No | Single title filter. | | `cursor` | string | No | Opaque next_cursor from the previous response. Pass it unchanged; all original filters and the limit are retained. | | `titles` | array | No | Job titles to match as alternatives. | | `channels` | array | No | Legacy contactability requirements; checks availability only. | | `job_title` | string | No | Legacy single job-title filter. | | `company_name` | string | No | Company name that anchors the search when no domain is known. | | `linkedin_url` | string | No | B2B company profile URL or slug that anchors the search. | | `channel_match` | string ("any" | "all") | No | Whether any or all requested channels must be available. | | `company_domain` | string | No | Company domain that anchors the people search. | | `people_filters` | object | No | People filters for names, titles, functions, levels, geography, profiles, languages, seniority, connection count, and channel availability. Values within one list are ORed; different keys are ANDed. | | `required_email` | boolean | No | Only return people with known email availability; no raw email is returned. | | `company_filters` | object | No | Criteria-based company set using the documented Company Search filters. | | `include_company` | boolean | No | Include base company data with each person. | | `required_mobile` | boolean | No | Only return people with known mobile availability; no raw number is returned. | | `include_domain_intel` | boolean | No | Include base domain intelligence with each person. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search People V3 Lookalike Docs Alias **Slug:** `LEADMAGIC_SEARCH_PEOPLE_V3_LOOKALIKE_DOCS_ALIAS` Call the distinct compatibility route POST /v3/people/lookalike; prefer the canonical route for new integrations. Returns one base-only cursor page and never requests raw contact details. Each returned person costs 1 credit on metered plans; zero results are free; maximum base exposure is 10 credits. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum people in this page (1-10); each returned person costs 1 credit on metered plans. | | `query` | string | No | Free-text people or title query. | | `roles` | array | No | Role or function labels to match. | | `title` | string | No | Single title filter. | | `cursor` | string | No | Opaque continuation cursor; pass it unchanged without repeating filters. | | `titles` | array | No | Job titles to match as alternatives. | | `channels` | array | No | Legacy contactability availability requirements. | | `job_title` | string | No | Legacy single job-title filter. | | `company_name` | string | No | Company name search anchor. | | `linkedin_url` | string | No | B2B company profile URL or slug search anchor. | | `channel_match` | string ("any" | "all") | No | Whether any or all requested channels must be available. | | `company_domain` | string | No | Company domain search anchor. | | `people_filters` | object | No | People filters; list values are ORed and different keys are ANDed. | | `required_email` | boolean | No | Require known email availability without returning the raw email. | | `company_filters` | object | No | Criteria-based company search anchor using Company Search filters. | | `include_company` | boolean | No | Include base company data with each person. | | `required_mobile` | boolean | No | Require known mobile availability without returning the raw number. | | `include_domain_intel` | boolean | No | Include base domain intelligence with each person. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search People V3 Mixed Docs Alias **Slug:** `LEADMAGIC_SEARCH_PEOPLE_V3_MIXED_DOCS_ALIAS` Call the distinct documented POST /v3/people/mixed-search alias. Prefer SEARCH_PEOPLE for new integrations. Returns one cursor page without raw contacts. Each returned person costs 1 base credit; zero results are free. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | People to return on this cursor page (1-10), at 1 base credit per result. | | `query` | string | No | Free-text people or title query. | | `roles` | array | No | Role or function labels to match. | | `title` | string | No | Single job title to match. | | `cursor` | string | No | Opaque next_cursor from the prior page. Pass unchanged; filters are retained. | | `titles` | array | No | Job titles to match as alternatives. | | `channels` | array | No | Legacy contact-availability requirements. | | `job_title` | string | No | Legacy single job-title filter. | | `company_name` | string | No | Company name to search. | | `linkedin_url` | string | No | Professional company profile URL or slug. | | `channel_match` | string ("any" | "all") | No | Whether any or all requested channels must be available. | | `company_domain` | string | No | Company domain to search. | | `people_filters` | object | No | People-level filters. Different keys are ANDed; array values are alternatives. | | `required_email` | boolean | No | Require known email availability; raw email is never unlocked. | | `company_filters` | object | No | Documented Company Search filters defining the company set. | | `include_company` | boolean | No | Include base company data with each person. | | `required_mobile` | boolean | No | Require known mobile availability; raw numbers are never unlocked. | | `include_domain_intel` | boolean | No | Include base domain intelligence with each person. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search People V3 Singular Docs Alias **Slug:** `LEADMAGIC_SEARCH_PEOPLE_V3_SINGULAR_DOCS_ALIAS` Call the distinct documented POST /v3/person/search alias. Prefer SEARCH_PEOPLE for new integrations. Returns one cursor page of base person data without raw contacts. Each returned person costs 1 base credit; zero results are free. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | People to return on this cursor page (1-10), at 1 base credit per result. | | `query` | string | No | Free-text people or title query. | | `roles` | array | No | Role or function labels to match. | | `title` | string | No | Single job title to match. | | `cursor` | string | No | Opaque next_cursor from the prior page. Pass it unchanged; filters are retained. | | `titles` | array | No | Job titles to match as alternatives. | | `channels` | array | No | Legacy contact-availability requirements. | | `job_title` | string | No | Legacy single job-title filter. | | `company_name` | string | No | Company name to search. | | `linkedin_url` | string | No | Professional company profile URL or slug. | | `channel_match` | string ("any" | "all") | No | Whether any or all requested channels must be available. | | `company_domain` | string | No | Company domain to search. | | `people_filters` | object | No | People-level filters. Different keys are combined with AND; array values are alternatives. | | `required_email` | boolean | No | Only return people with known email availability; raw email is never unlocked. | | `company_filters` | object | No | Documented Company Search filters defining the company set. | | `include_company` | boolean | No | Include base company data with each person. | | `required_mobile` | boolean | No | Only return people with known mobile availability; raw numbers are never unlocked. | | `include_domain_intel` | boolean | No | Include base domain intelligence with each person. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Submit Bulk Job **Slug:** `LEADMAGIC_SUBMIT_BULK_JOB` Create one asynchronous bulk enrichment job from exactly one input mode. This can consume credits for every processed row. Retain the returned jobId and use only that owned ID for follow-up reads or lifecycle changes. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `csv` | string | No | Inline CSV data. Mutually exclusive with rows, file_url, and scrape. | | `rows` | array | No | Inline JSON row objects. Mutually exclusive with csv, file_url, and scrape. | | `format` | string ("csv" | "json" | "jsonl") | No | Remote file format; valid only with file_url. | | `scrape` | object | No | Browser-rendering input. Mutually exclusive with rows, csv, and file_url. | | `product` | string | Yes | Enrichment product applied to every submitted row. | | `callback` | object | No | Optional webhook delivery configuration. | | `file_url` | string | No | Public HTTPS CSV, JSON, or JSONL URL. Mutually exclusive with rows, csv, and scrape. | | `metadata` | object | No | Caller metadata attached to the bulk job. | | `priority` | integer | No | Queue priority from -1000 to 1000. | | `file_name` | string | No | Label shown for the job in the LeadMagic dashboard. | | `preset_id` | string | No | Saved bulk preset identifier. | | `input_mapping` | object | No | Map source columns or fixed values to product input fields. | | `idempotency_key` | string | No | Stable key that makes retries resolve to the same submission. | | `output_transform` | object | No | Optional transformation applied to completed row output. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Submit Bulk Local Leads Job **Slug:** `LEADMAGIC_SUBMIT_BULK_LOCAL_LEADS_JOB` Create a long-running local-leads bulk job. Every keyword-city combination becomes work and may consume credits. Retain the returned jobId and use only that owned ID for follow-up reads or lifecycle changes. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cities` | array | Yes | Cities expanded against every keyword. | | `keywords` | array | Yes | Search terms expanded against every city, one row per keyword-city pair. | | `file_name` | string | No | Label shown for the job in the LeadMagic dashboard. | | `magic_key` | string | No | Promotional key that waives charges only when LeadMagic accepts it. | | `country_codes` | array | No | Two-letter country code per city, aligned by index; omitted entries default to US. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Submit Mixed Product Batch **Slug:** `LEADMAGIC_SUBMIT_MIXED_PRODUCT_BATCH` Create one asynchronous mixed-product enrichment batch. This can consume credits for every item: preview the exact payload first, keep the item count bounded, and supply an idempotency_key before submitting. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `items` | array | Yes | One to 500 mixed-product batch items. Every item explicitly names its product and input. | | `metadata` | object | No | Arbitrary metadata stored with the whole batch. | | `priority` | string ("normal" | "low") | No | Queue priority for the batch. | | `client_id` | string | No | Client identifier associated with the whole batch. | | `client_name` | string | No | Client name recorded with the whole batch. | | `webhook_url` | string | No | Public HTTPS URL to notify when the batch completes. | | `budget_user_id` | string | No | Member whose credit budget should be charged. | | `idempotency_key` | string | No | Deduplication key. Reusing it returns the original batch instead of creating another. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Batch Metadata **Slug:** `LEADMAGIC_UPDATE_BATCH_METADATA` Update metadata or client association for an owned batch during its mutable window. Use only a product and batch_id captured from the same submitted batch; never mutate a batch discovered by listing workspace data. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `product` | string | Yes | Enrichment product slug for the batch. Hyphens and underscores are accepted. | | `batch_id` | string | Yes | Identifier of the owned batch to update. | | `metadata` | object | No | Replacement provider-defined metadata for the batch. | | `client_id` | string | No | Client identifier to associate with the batch. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Bulk Job Priority **Slug:** `LEADMAGIC_UPDATE_BULK_JOB_PRIORITY` Change the priority of a queued or running LeadMagic bulk job owned by the connected workspace. This mutates scheduling but does not restart the job or change which rows it processes. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `job_id` | string | Yes | UUID of a queued or running bulk job created and owned by the connected workspace. Never reprioritize a pre-existing unrelated job. | | `priority` | integer | Yes | New queue priority from -1000 (lowest) to 1000 (highest). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Credit Budget **Slug:** `LEADMAGIC_UPDATE_CREDIT_BUDGET` Update one or more controls on a credit budget created and owned by the caller. Use only an id captured from that owned budget lifecycle; never modify a budget discovered incidentally in workspace listings. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | Identifier of the owned budget to update. | | `period` | string | No | Replacement budget reset period. | | `alert_email` | string | No | Replacement email address for budget threshold alerts. | | `max_credits` | number | No | Replacement credit limit for each budget period. | | `alert_threshold_pct` | number | No | Replacement alert threshold as a fraction from 0 to 1. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Validate Bulk Submission **Slug:** `LEADMAGIC_VALIDATE_BULK_SUBMISSION` Validate exactly one bulk input mode and its options without persisting or processing a job. This is a contract check, not a submission. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `csv` | string | No | Inline CSV; exclusive with rows, file_url, and scrape. | | `rows` | array | No | Inline JSON rows; exclusive with csv, file_url, and scrape. | | `format` | string ("csv" | "json" | "jsonl") | No | Format for file_url only. | | `scrape` | object | No | Browser input; exclusive with rows, csv, and file_url. | | `product` | string | Yes | Enrichment product to validate. | | `callback` | object | No | Callback configuration. | | `file_url` | string | No | Public HTTPS input URL; exclusive with rows, csv, and scrape. | | `metadata` | object | No | Job metadata. | | `priority` | integer | No | Queue priority from -1000 to 1000. | | `file_name` | string | No | Dashboard job label. | | `preset_id` | string | No | Saved bulk preset identifier. | | `input_mapping` | object | No | Source-to-product field mapping. | | `idempotency_key` | string | No | Submission idempotency key. | | `output_transform` | object | No | Completed-row output transformation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Validate Email **Slug:** `LEADMAGIC_VALIDATE_EMAIL` Check one email address for deliverability and return mail-server and company context. A definitive valid or invalid result costs 0.25 credits; an unknown result is free. Exactly one email is validated per call. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `email` | string | Yes | The single email address to validate. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not |