Skip to content

Companies

Read company facts and signals, analyze a company website, and refresh or enrich companies.

Full name: campaignstack_analyze_company_website

campaigns:read Read-only

Renamed V2 website-analysis read for a company’s own public website. Cached analyses are reused; fresh AI extraction is credit-gated and charged to the bound workspace. Charges website_intel credits per call; campaignstack_estimate_cost gives the number before you commit.

NameTypeRequiredDefaultDescription
workspaceIdstringNo—Workspace ID. Omit it when this connection reaches one workspace: a workspace key (cs_) is bound to its own, and a user key (csu_) or connected app whose person belongs to exactly one workspace defaults to that one. Required only when the person belongs to several; the error then lists them, and campaignstack_whoami reports them too.
urlstringYes—

Full name: campaignstack_get_companies

leads:read Read-only

Read companies by ids or page workspace companies in one bounded V2 envelope. Optional includes cover signals, funding, discovery rows, employees, metric history, reviews, news, and a bounded jobs page with filters. Use nearest specialist tools for deeper company intelligence or refreshes; this read does not fetch new data. Results are one page. When pagination reports more, say so rather than presenting the page as the whole set, and page through before counting anything.

NameTypeRequiredDefaultDescription
workspaceIdstringNo—Workspace ID. Omit it when this connection reaches one workspace: a workspace key (cs_) is bound to its own, and a user key (csu_) or connected app whose person belongs to exactly one workspace defaults to that one. Required only when the person belongs to several; the error then lists them, and campaignstack_whoami reports them too.
idsstring[]No—Specific company IDs to hydrate. Max 25.
querystringNo—Search by name prefix, domain or LinkedIn company URL across this workspace’s companies and the shared company database. Returns up to 10, each marked inWorkspace. (min length: 2, max length: 120)
limitintegerNo20(min: 1, max: 100)
cursorstringNo—
includeobjectNo{}
include.signalsbooleanNofalse
include.fundingbooleanNofalse
include.discoveriesbooleanNofalse
include.employeesbooleanNofalse
include.metricHistorybooleanNofalse
include.reviewsbooleanNofalse
include.newsbooleanNofalse
include.jobsobjectNo—Include one bounded page of stored job postings for each company. Pass {} for the first page, or filters/cursor for a narrowed page.
include.limitintegerNo10(min: 1, max: 50)

Full name: campaignstack_refresh_companies

leads:write Acts outside CampaignStack

Start a full company refresh for up to 25 companies. There is no sections argument: the backend schedules all available company-refresh components and returns per-company partial status including gates and already-queued rows. Charges company_refresh credits per call; campaignstack_estimate_cost gives the number before you commit.

NameTypeRequiredDefaultDescription
workspaceIdstringNo—Workspace ID. Omit it when this connection reaches one workspace: a workspace key (cs_) is bound to its own, and a user key (csu_) or connected app whose person belongs to exactly one workspace defaults to that one. Required only when the person belongs to several; the error then lists them, and campaignstack_whoami reports them too.
companyIdsstring[]Yes—

Full name: campaignstack_enrich_companies

leads:write Acts outside CampaignStack

Run provider firmographic enrichment for up to 25 companies. Company firmographics are shared public-domain data; provider/API-key errors are reported per company.

NameTypeRequiredDefaultDescription
workspaceIdstringNo—Workspace ID. Omit it when this connection reaches one workspace: a workspace key (cs_) is bound to its own, and a user key (csu_) or connected app whose person belongs to exactly one workspace defaults to that one. Required only when the person belongs to several; the error then lists them, and campaignstack_whoami reports them too.
companyIdsstring[]Yes—
providerapollo | clayNo"apollo"
clayRoutineIdstringNo—

Full name: campaignstack_edit_companies

leads:write

Patch per-workspace company overlays (tags/notes) for up to 50 shared or private companies. This does not mutate shared firmographics.

NameTypeRequiredDefaultDescription
workspaceIdstringNo—Workspace ID. Omit it when this connection reaches one workspace: a workspace key (cs_) is bound to its own, and a user key (csu_) or connected app whose person belongs to exactly one workspace defaults to that one. Required only when the person belongs to several; the error then lists them, and campaignstack_whoami reports them too.
companiesobject[]Yes—

Full name: campaignstack_lookup_company

leads:write Acts outside CampaignStack Feature: company_data_platform

Call this when the user asks for a company that campaignstack_get_companies with a query does not find. With query, CampaignStack searches the web for matching LinkedIn company pages and returns up to 5 (companyId is set when CampaignStack already holds one). With linkedinUrl, CampaignStack reads that public company page and adds the company to the shared company database; the answer is ready with a companyId, or queued (call again with the same linkedinUrl to check), or failed. Pass exactly one of the two. Free, up to 50 searches and 50 new pages per workspace per day. It does not add the company to a campaign or reach anyone at it.

NameTypeRequiredDefaultDescription
workspaceIdstringNo—Workspace ID. Omit it when this connection reaches one workspace: a workspace key (cs_) is bound to its own, and a user key (csu_) or connected app whose person belongs to exactly one workspace defaults to that one. Required only when the person belongs to several; the error then lists them, and campaignstack_whoami reports them too.
querystringNo—Company name or domain to find on LinkedIn. Returns up to 5 company pages; none is added yet. (min length: 2, max length: 120)
linkedinUrlstringNo—A linkedin.com/company/ page to add. Call again with the same URL to read where the read stands. (min length: 1)