This documentation is a technical manual for the LeadConduit API. It is
primarily intended to be read by software developers who want to integrate
another system with LeadConduit.The API is RESTful and speaks JSON over HTTPS. In general, anything that
can be accomplished by pointing and clicking in the LeadConduit user
interface can also be done using the API.
If you have a question, or spot an error in the documentation, or just
generally need to speak with someone about the API, email
support@activeprospect.com.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"ActiveProspect Developer Documentation","colors":{"primary":"#22a7f0","light":"#79caf6","dark":"#22a7f0"},"logo":{"light":"https://mintcdn.com/activeprospectinc/ttzTIJYOTNQPAJMy/logo/activeprospect_logo.svg?fit=max\u0026auto=format\u0026n=ttzTIJYOTNQPAJMy\u0026q=85\u0026s=9c7503c7631642aa1f7288ae35cc02cc","dark":"https://mintcdn.com/activeprospectinc/ttzTIJYOTNQPAJMy/logo/activeprospect_whiteblue.svg?fit=max\u0026auto=format\u0026n=ttzTIJYOTNQPAJMy\u0026q=85\u0026s=3df29616a4d6781de4873141e49ca8e0"},"favicon":"https://mintcdn.com/activeprospectinc/ybHg7UeILJeU2Jw-/favicon.png?fit=max\u0026auto=format\u0026n=ybHg7UeILJeU2Jw-\u0026q=85\u0026s=95060b05f4b73bb5ad4a373e19c17430","navbar":{"links":[{"href":"https://support.activeprospect.com/hc/en-us","label":"Support"}],"primary":{"type":"button","label":"Sign in to ActiveProspect","href":"https://account.activeprospect.com"}},"footer":{"socials":{"facebook":"https://www.facebook.com/activeprospect","x":"https://twitter.com/activeprospect","instagram":"https://www.instagram.com/activeprospectinc","linkedin":"https://www.linkedin.com/company/activeprospect","youtube":"https://www.youtube.com/channel/UCN_HLECy6KzYhFfIyLM50rQ","github":"https://github.com/activeprospect"},"links":[{"header":"Customers","items":[{"label":"Knowledge Base","href":"https://support.activeprospect.com/hc/en-us"},{"label":"Start Certifying your Leads","href":"https://account.activeprospect.com/register/trustedform/certify"},{"label":"Product What's New","href":"https://whatsnew.activeprospect.com/"},{"label":"Platform Status","href":"https://status.activeprospect.com/"},{"label":"Integrations","href":"https://activeprospect.com/integrations"},{"label":"Add-ons","href":"https://activeprospect.com/leadconduit/add-on-services"},{"label":"Support Plans","href":"https://activeprospect.com/support-plans"}]},{"header":"Resources","items":[{"label":"TrustedForm Cert Demo","href":"https://activeprospect.com/products/trustedform-demo"},{"label":"Talk to an Expert","href":"https://activeprospect.com/get-demo"},{"label":"Blog","href":"https://activeprospect.com/blog"},{"label":"InsideCBM","href":"https://activeprospect.com/inside-cbm"},{"label":"Glossary","href":"https://activeprospect.com/glossary"},{"label":"TCPA Compliance","href":"https://activeprospect.com/tcpa-compliance"},{"label":"Ping Pick Post","href":"https://activeprospect.com/ping-pick-post"}]},{"header":"Company","items":[{"label":"About Us","href":"https://activeprospect.com/about-us"},{"label":"Conferences and Events","href":"https://activeprospect.com/activeprospect-events"},{"label":"Careers","href":"https://activeprospect.com/careers"},{"label":"Security","href":"https://activeprospect.com/security"},{"label":"Security Information Portal","href":"https://security.activeprospect.com/"},{"label":"Contact Us","href":"https://activeprospect.com/contact-us"}]},{"header":"Legal","items":[{"label":"Privacy Policy","href":"https://activeprospect.com/privacy-policy"},{"label":"TrustedForm Privacy Policy","href":"https://activeprospect.com/trustedform-privacy-notice"},{"label":"Privacy Notice for California Residents","href":"https://activeprospect.com/privacy-notice-california"},{"label":"Terms of Service","href":"https://activeprospect.com/terms-of-service"},{"label":"TrustedForm Certify EULA","href":"https://activeprospect.com/trustedform-eula"}]}]},"seo":{"metatags":{"canonical":"https://developers.activeprospect.com"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"activeprospectinc","hasAudioNarration":false,"actualSubdomain":"activeprospectinc","customDomains":["developers.activeprospect.com"],"gitSource":{"type":"github","owner":"activeprospect","repo":"documentation","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae8c8b6305194f11301916a","collectionId":"e72ed83b-2f42-49a8-9acd-19cc68248297","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae8c8b6305194f11301916a"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae8c8b6305194f11301916a","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"API Documentation","count":115},{"language":"default","tag":"LeadConduit","count":99},{"language":"default","tag":"API Endpoints","count":92},{"language":"default","tag":"TrustedForm","count":26},{"language":"default","tag":"Flows","count":18},{"language":"default","tag":"TrustedForm API 4.0","count":11},{"language":"default","tag":"Account","count":9},{"language":"default","tag":"Fields","count":9},{"language":"default","tag":"Caps and Limits","count":8},{"language":"default","tag":"Operations","count":8}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".black-headline{color:#000;font-weight:700;font-size:18px}.tfbody{border:1px solid #000;background-color:#9bcae3;font-family:\"proxima nova\",sans-serif;color:#131718;width:670px;margin:0 auto;padding:20px;font-size:18px}.tfbody input{background-color:#6fb3c1;display:block;margin:10px 0;padding:6px 0;font-size:14px}.tfbody input[type=checkbox]{display:inline}.tfbody input[type=email],.tfbody input[type=password],.tfbody textarea{color:#fff;min-width:90%}.tfbody input[type=text]{color:#fff;min-width:90%;width:200px}.tfbody a{color:#fff}.tfbody .consent_copy{margin:auto;width:80%}.tfbody .form_field_hldr_hldr{width:100%;padding:12px}.tfbody .form_field_hldr{width:44%;display:inline-block}.check-wrapper{padding:6px}#test-form{margin:auto}#consent_tag_target{color:#00008b;width:100%;text-align:center;margin:6px;height:2rem}.indentpar{display:inline}.indented{margin-left:22px;margin-top:-28px;line-height:22px}[data-tf-element-role=\"\"],[data-tf-element-role=consent-language],[data-tf-element-role=offer]{border:2px solid #9bcae3}[data-tf-element-role=offer]:hover{border:2px solid #ff0}[data-tf-element-role=consent-language]:hover{border:2px solid #adff2f}.consent-hilight>* [data-tf-element-role]:not([data-tf-element-role=offer]):not([data-tf-element-role=consent-language]){background-color:inherit;box-shadow:0 0 1px 1px #8a2be2}.consent-hilight>[data-tf-element-role]:not([data-tf-element-role=offer]):not([data-tf-element-role=consent-language]){background-color:#ff0!important;box-shadow:0 0 1px 1px #8a2be2}[data-tf-element-role]:not([data-tf-element-role=offer]):not([data-tf-element-role=consent-language]):hover{background-color:#ff0}"}],"page":{"pagePath":"api-reference/leadconduit","slug":"/api-reference/leadconduit","pageMetadata":{"title":"About","description":null,"href":"/api-reference/leadconduit"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock,Heading}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`This documentation is a technical manual for the LeadConduit API. It is\nprimarily intended to be read by software developers who want to integrate\nanother system with LeadConduit.`}),`\n`,_jsx(_components.p,{children:`The API is RESTful and speaks JSON over HTTPS. In general, anything that\ncan be accomplished by pointing and clicking in the LeadConduit user\ninterface can also be done using the API.`}),`\n`,_jsx(Heading,{level:`2`,id:`conventions`,children:`Conventions`}),`\n`,_jsx(_components.p,{children:`This documentation provides examples that show how to interact with the\nAPI. Examples are shown in monospaced blocks like the one shown below:`}),`\n`,_jsx(CodeBlock,{numberOfLines:`2`,language:`text`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`text`,children:_jsxs(_components.code,{language:`text`,numberOfLines:`2`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{children:`Examples are presented in blocks like this one`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{})})]})})}),`\n`,_jsxs(_components.p,{children:[`You may also see monospaced font inline `,_jsx(_components.code,{children:`like this`}),`. This text represents a\nliteral value or expression to be used with the API.`]}),`\n`,_jsx(Heading,{level:`2`,id:`questions`,children:`Questions`}),`\n`,_jsxs(_components.p,{children:[`If you have a question, or spot an error in the documentation, or just\ngenerally need to speak with someone about the API, email\n`,_jsx(_components.a,{href:`mailto:support@activeprospect.com`,children:`support@activeprospect.com`}),`.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"About","description":null,"href":"/api-reference/leadconduit"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Conventions","slug":"conventions","depth":2,"children":[]},{"title":"Questions","slug":"questions","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"activeprospectinc","siteName":"ActiveProspect Developer Documentation","title":"About - ActiveProspect Developer Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-02T17:30:41.753Z","originalFileLocation":"api-reference/leadconduit.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"ActiveProspect Developer Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/activeprospectinc/-voIGRv_PaCQr-Wj/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/activeprospectinc/-voIGRv_PaCQr-Wj/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/activeprospectinc/-voIGRv_PaCQr-Wj/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/activeprospectinc/-voIGRv_PaCQr-Wj/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/activeprospectinc/-voIGRv_PaCQr-Wj/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/activeprospectinc/-voIGRv_PaCQr-Wj/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/activeprospectinc/-voIGRv_PaCQr-Wj/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/activeprospectinc/-voIGRv_PaCQr-Wj/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/activeprospectinc/-voIGRv_PaCQr-Wj/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"About - ActiveProspect Developer Documentation\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"ActiveProspect Developer Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.activeprospect.com/api-reference/leadconduit\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://activeprospectinc.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=About\u0026amp;theme=82b92e625aa25be6cc045629\u0026amp;signature=d34af127facf0ae518f0a6985675d97475f92125a428a6b09e22d4e9cdf69e61\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"About - ActiveProspect Developer Documentation\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://activeprospectinc.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=About\u0026amp;theme=82b92e625aa25be6cc045629\u0026amp;signature=d34af127facf0ae518f0a6985675d97475f92125a428a6b09e22d4e9cdf69e61\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/activeprospectinc/-voIGRv_PaCQr-Wj/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"ActiveProspect Developer Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#22a7f0\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.activeprospect.com/api-reference/leadconduit\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/leadconduit.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.activeprospect.com/#organization\",\"name\":\"ActiveProspect Developer Documentation\",\"url\":\"https://developers.activeprospect.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/activeprospectinc/ttzTIJYOTNQPAJMy/logo/activeprospect_logo.svg?fit=max\u0026auto=format\u0026n=ttzTIJYOTNQPAJMy\u0026q=85\u0026s=9c7503c7631642aa1f7288ae35cc02cc\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.activeprospect.com#website\",\"name\":\"ActiveProspect Developer Documentation\",\"url\":\"https://developers.activeprospect.com\",\"publisher\":{\"@id\":\"https://developers.activeprospect.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.activeprospect.com/api-reference/leadconduit#webpage\",\"url\":\"https://developers.activeprospect.com/api-reference/leadconduit\",\"name\":\"About\",\"dateModified\":\"2026-11-02T17:30:41.753Z\",\"isPartOf\":{\"@id\":\"https://developers.activeprospect.com#website\"}},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://developers.activeprospect.com/api-reference/leadconduit#article\",\"headline\":\"About\",\"name\":\"About\",\"url\":\"https://developers.activeprospect.com/api-reference/leadconduit\",\"mainEntityOfPage\":{\"@id\":\"https://developers.activeprospect.com/api-reference/leadconduit#webpage\"},\"dateModified\":\"2026-11-02T17:30:41.753Z\",\"publisher\":{\"@id\":\"https://developers.activeprospect.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.activeprospect.com#website\"}}]}\u003c/script>","siteName":"ActiveProspect Developer Documentation","nav":{"global":null,"tabs":[{"tab":"Welcome","pages":[{"title":"Welcome","href":""}]},{"tab":"TrustedForm","pages":[{"title":"TrustedForm","href":"/pages/trustedform/getting-started"}]},{"tab":"LeadConduit","pages":[{"title":"About","href":"/api-reference/leadconduit"},{"title":"Authentication","description":null,"href":"/pages/leadconduit/authentication"},{"group":"API Documentation","pages":[{"group":"API Endpoints","pages":[{"group":"Flows","root":{"title":"Flows","href":"/api-reference/leadconduit/flows"},"pages":[{"title":null,"href":"/api-reference/leadconduit/flows/destination"},{"title":null,"href":"/api-reference/leadconduit/flows/flow"},{"title":null,"href":"/api-reference/leadconduit/flows/meta"},{"title":"Submission response","sidebarTitle":"Submission response","href":"/api-reference/leadconduit/flows/submission-response"},{"title":"Ping response","sidebarTitle":"Ping response","href":"/api-reference/leadconduit/flows/ping-response"},{"title":"List all flows","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json get /flows","href":"/api-reference/flows/list-all-flows"},{"title":"Update all flows","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json put /flows","href":"/api-reference/flows/update-all-flows"},{"title":"Create a new flow","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json post /flows","href":"/api-reference/flows/create-a-new-flow"},{"title":"Get a flow","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json get /flows/{id}","href":"/api-reference/flows/get-a-flow"},{"title":"Update an existing flow","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json put /flows/{id}","href":"/api-reference/flows/update-an-existing-flow"},{"title":"Delete an existing flow","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json delete /flows/{id}","href":"/api-reference/flows/delete-an-existing-flow"},{"title":"Deploy a saved flow to production","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json post /flows/{id}/deploy","href":"/api-reference/flows/deploy-a-saved-flow-to-production"},{"title":"List fields associated to the Flow","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json get /flows/{id}/fields","href":"/api-reference/flows/list-fields-associated-to-the-flow"},{"title":"Get flow field usages","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json get /flows/{id}/fields/usage","href":"/api-reference/flows/get-flow-field-usages"},{"title":"Retrieve metadata for a specific source within a flow","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json get /flows/{flow_id}/sources/{source_id}/meta","href":"/api-reference/flows/retrieve-metadata-for-a-specific-source-within-a-flow"},{"title":"Submit data to a source within a flow","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json post /flows/{flow_id}/sources/{source_id}/submit","href":"/api-reference/flows/submit-data-to-a-source-within-a-flow"},{"title":"Ping a source within a flow","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json get /flows/{flow_id}/sources/{source_id}/ping","href":"/api-reference/flows/ping-a-source-within-a-flow"},{"title":"Ping a source within a flow with a request body","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json post /flows/{flow_id}/sources/{source_id}/ping","href":"/api-reference/flows/ping-a-source-within-a-flow-with-a-request-body"}]},{"group":"Leads","root":{"title":"Leads","href":"/api-reference/leadconduit/leads"},"pages":[{"title":null,"href":"/api-reference/leadconduit/leads/event"},{"title":"List all events","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json get /events","href":"/api-reference/leads/list-all-events"},{"title":"List all events for exports","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json post /events","href":"/api-reference/leads/list-all-events-for-exports"},{"title":"Fetch a single event","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json get /events/{id}","href":"/api-reference/leads/fetch-a-single-event"}]},{"group":"Feedback","root":{"title":"Feedback","href":"/api-reference/leadconduit/feedback"},"pages":[{"title":"Feedback submission","sidebarTitle":"Feedback submission","href":"/api-reference/leadconduit/feedback/feedback-submission"},{"title":"Feedback result","sidebarTitle":"Feedback result","href":"/api-reference/leadconduit/feedback/feedback-submission-result"},{"title":"Submit feedback for a lead","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json post /feedback","href":"/api-reference/feedback/submit-feedback-for-a-lead"},{"title":"Submit feedback for a lead using query parameters","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json get /feedback","href":"/api-reference/feedback/submit-feedback-for-a-lead-using-query-parameters"},{"title":"Submit feedback for a lead using your own record ID","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json post /feedback/{recipient_name}","href":"/api-reference/feedback/submit-feedback-for-a-lead-using-your-own-record-id"}]},{"group":"Exports","root":{"title":"Exports","href":"/api-reference/leadconduit/exports"},"pages":[{"title":null,"href":"/api-reference/leadconduit/exports/export"},{"title":"List all exports","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json get /exports","href":"/api-reference/exports/list-all-exports"},{"title":"Create an export","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json post /exports","href":"/api-reference/exports/create-an-export"},{"title":"Get an export","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json get /exports/{id}","href":"/api-reference/exports/get-an-export"},{"title":"Get a download link for an export","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json get /exports/{id}/file","href":"/api-reference/exports/get-a-download-link-for-an-export"}]},{"group":"Fields","pages":[{"title":null,"href":"/api-reference/leadconduit/fields/field"},{"title":null,"href":"/api-reference/leadconduit/fields/type"},{"title":"List all fields","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json get /fields","href":"/api-reference/fields/list-all-fields"},{"title":"Create a field","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json post /fields","href":"/api-reference/fields/create-a-field"},{"title":"Get a field","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json get /fields/{id}","href":"/api-reference/fields/get-a-field"},{"title":"Update a field","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json put /fields/{id}","href":"/api-reference/fields/update-a-field"},{"title":"Delete a field","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json delete /fields/{id}","href":"/api-reference/fields/delete-a-field"},{"title":"List changes to a Field","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json get /fields/{id}/changelogs","href":"/api-reference/fields/list-changes-to-a-field"},{"title":"List data types","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json get /types","href":"/api-reference/fields/list-data-types"}]},{"group":"Entities","root":{"title":"Entities","href":"/api-reference/leadconduit/entities"},"pages":[{"title":null,"href":"/api-reference/leadconduit/entities/entity"},{"title":"List all entities","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json get /entities","href":"/api-reference/entities/list-all-entities"},{"title":"Create an entity","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json post /entities","href":"/api-reference/entities/create-an-entity"},{"title":"Get an entity","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json get /entities/{id}","href":"/api-reference/entities/get-an-entity"},{"title":"Update an entity","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json put /entities/{id}","href":"/api-reference/entities/update-an-entity"},{"title":"Delete an entity","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json delete /entities/{id}","href":"/api-reference/entities/delete-an-entity"},{"title":"List changes to an Entity","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json get /entities/{id}/changelogs","href":"/api-reference/entities/list-changes-to-an-entity"}]},{"group":"Packages","root":{"title":"Packages","href":"/api-reference/leadconduit/packages"},"pages":[{"title":"Package","sidebarTitle":"Package","href":"/api-reference/leadconduit/packages/package"},{"title":"List all integration packages","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json get /packages","href":"/api-reference/packages/list-all-integration-packages"},{"title":"Fetch a single integration package","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json get /packages/{id}","href":"/api-reference/packages/fetch-a-single-integration-package"}]},{"group":"Changelogs","root":{"title":"Changelogs","href":"/api-reference/leadconduit/changelogs"},"pages":[{"title":null,"href":"/api-reference/leadconduit/changelogs/changelog"},{"title":"List all changelogs","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json get /changelogs","href":"/api-reference/changelogs/list-all-changelogs"},{"title":"Get a changelog","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json get /changelogs/{id}","href":"/api-reference/changelogs/get-a-changelog"},{"title":"List changes to a Flow","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json get /flows/{id}/changelogs","href":"/api-reference/changelogs/list-changes-to-a-flow"}]},{"group":"Reports","pages":[{"title":null,"href":"/api-reference/leadconduit/reports/report"},{"title":"List all reports","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json get /reports","href":"/api-reference/reports/list-all-reports"},{"title":"Create a new report","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json post /reports","href":"/api-reference/reports/create-a-new-report"},{"title":"Fetch a single report","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json get /reports/{id}","href":"/api-reference/reports/fetch-a-single-report"},{"title":"Update an existing report","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json put /reports/{id}","href":"/api-reference/reports/update-an-existing-report"},{"title":"Delete a report","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json delete /reports/{id}","href":"/api-reference/reports/delete-a-report"},{"title":"Run a report","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json get /reports/{id}/run","href":"/api-reference/reports/run-a-report"}]},{"group":"Caps and Limits","root":{"title":"Caps and Limits","href":"/api-reference/leadconduit/caps-and-limits"},"pages":[{"title":null,"href":"/api-reference/leadconduit/caps-and-limits/cap"},{"title":null,"href":"/api-reference/leadconduit/caps-and-limits/cap-counter"},{"title":null,"href":"/api-reference/leadconduit/caps-and-limits/pinglimit"},{"title":null,"href":"/api-reference/leadconduit/caps-and-limits/pinglimit-counter"},{"title":"List all cap counters","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json get /caps","href":"/api-reference/caps-and-limits/list-all-cap-counters"},{"title":"Get a cap counter","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json get /caps/{id}","href":"/api-reference/caps-and-limits/get-a-cap-counter"},{"title":"List all ping limit counters","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json get /ping_limits","href":"/api-reference/caps-and-limits/list-all-ping-limit-counters"},{"title":"Fetch a ping limit counter","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json get /ping_limits/{id}","href":"/api-reference/caps-and-limits/fetch-a-ping-limit-counter"}]},{"group":"Firehose","root":{"title":"Firehose","href":"/api-reference/leadconduit/firehose"},"pages":[{"title":"Test firehose's ability to write to AWS S3 or Azure Blob Storage","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json get /firehose","href":"/api-reference/firehose/test-firehoses-ability-to-write-to-aws-s3-or-azure-blob-storage"}]},{"group":"Routers","pages":[{"title":null,"href":"/api-reference/leadconduit/router"},{"title":"List all routers","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json get /routers","href":"/api-reference/routers/list-all-routers"},{"title":"Create a router","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json post /routers","href":"/api-reference/routers/create-a-router"},{"title":"Get a router","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json get /routers/{id}","href":"/api-reference/routers/get-a-router"},{"title":"Update a router","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json put /routers/{id}","href":"/api-reference/routers/update-a-router"},{"title":"Submit a lead to a router","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json post /routers/{router_id}/route","href":"/api-reference/routers/submit-a-lead-to-a-router"},{"title":"Submit a lead to a router using query parameters","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json get /routers/{router_id}/route","href":"/api-reference/routers/submit-a-lead-to-a-router-using-query-parameters"}]},{"group":"Account","root":{"title":"Account","href":"/api-reference/leadconduit/account"},"pages":[{"title":null,"href":"/api-reference/leadconduit/account/account"},{"title":null,"href":"/api-reference/leadconduit/account/credential"},{"title":"Get account","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json get /account","href":"/api-reference/account/get-account"},{"title":"Update account","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json put /account","href":"/api-reference/account/update-account"},{"title":"List all credentials","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json get /credentials","href":"/api-reference/account/list-all-credentials"},{"title":"Create a new credential","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json post /credentials","href":"/api-reference/account/create-a-new-credential"},{"title":"Get a credential","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json get /credentials/{id}","href":"/api-reference/account/get-a-credential"},{"title":"Update a credential","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json put /credentials/{id}","href":"/api-reference/account/update-a-credential"},{"title":"Delete a credential","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json delete /credentials/{id}","href":"/api-reference/account/delete-a-credential"}]},{"group":"Connections","root":{"title":"Connections","href":"/api-reference/leadconduit/connections"},"pages":[{"title":"List connections","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json get /connections","href":"/api-reference/connections/list-connections"},{"title":"Repair: materialize a missing LC connection","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json post /connections","href":"/api-reference/connections/repair:-materialize-a-missing-lc-connection"},{"title":"Get connection by ID","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json get /connections/{id}","href":"/api-reference/connections/get-connection-by-id"}]},{"group":"System","pages":[{"title":null,"href":"/api-reference/leadconduit/system/status"},{"title":"Get system status","deprecated":null,"version":null,"openapi":"/api-reference/leadconduit_api.json get /status","href":"/api-reference/system/get-system-status"}]}]}]},{"group":"Concepts","pages":[{"group":"Rules","root":{"title":"Rules","href":"/api-reference/leadconduit/rules"},"pages":[{"title":null,"href":"/api-reference/leadconduit/rules/rule"},{"title":null,"href":"/api-reference/leadconduit/rules/rule-set"}]},{"group":"Variables","root":{"title":"Variables","href":"/api-reference/leadconduit/variables"},"pages":[{"title":null,"href":"/api-reference/leadconduit/variables/variables"}]},{"title":"Types","href":"/api-reference/leadconduit/types"},{"title":"Templates","href":"/api-reference/leadconduit/templates"}]}]}]},"basePath":"","title":"About - ActiveProspect Developer Documentation","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":[],"chunks":[]}