Kamata
Start free trial

Kamata REST API

JSON over HTTPS at https://api.kamata.ai/v1. The same data the MCP server gives an assistant, for your own code.

Authentication · Reference · Examples · Results · Risk grades · Batches and pagination · Webhooks · Rate limits · Errors · Credits

Authentication

Send an API key on every request:

Authorization: Bearer sk_live_…
ScopeAllows
leads:readRead leads, contacts, searches, results and jobs
leads:writeApprove, reject and edit leads, run searches and reveals, tags
agents:readRead agents, plays and competitors
agents:writeCreate and change agents
signals:readRead signals and search people and companies
inbox:readRead replies and sent email
inbox:writeAnswer and manage replies
exclusions:readRead exclusions
exclusions:writeAdd and remove exclusions
imports:readRead imports
imports:writeImport and enrich lists
watchlist:readRead the watchlist
watchlist:writeWatch and unwatch companies
visitors:readRead website visitors
visitors:writeManage visitor sites and rules
workspace:readRead the workspace, usage, plan and integrations
mailboxes:readRead mailboxes and their health
webhooks:readRead workspace webhook endpoints
webhooks:writeManage workspace webhook endpoints
copilot:readAsk the assistant
mcp:readConnect to the MCP server and use read tools
mcp:writeMCP write tools (paid lookups and changes)
signals:writeCreate custom signals, rules and lookalike runs
events:readRead product events
events:writeSend product events
data:readRead credits, lookups and batches
data:writeRun lookups, verifications, enrichments and uploads (spends credits)
mailboxes:write
support:write

Reference

Every endpoint an API key can call, grouped by area and generated from the server's own routes (the same list as openapi.json). The scope column is what the key needs; outbound marks endpoints on the outbound plans (the Data plan gets 402 plan_limit).

No vendor call happens inside a request: a create answers at once (200 when it is already done, 202 while it runs) and the work continues in the background. wait_s (0–25) waits that many seconds for the answer first. Background jobs: GET /v1/jobs/:id.

Emails

Find verified work emails and verify addresses, one at a time or as a list.

EndpointScopeWhat it doesInputReturns
POST /v1/data/find-emaildata:writeFind a verified work email{ person: {linkedin_url} | {full_name, domain} | {first_name, last_name, domain} }202, as verify-email
POST /v1/data/verify-emaildata:writeVerify one email as a lookup job{ email }202 { job_id, progress_id, action, status: "queued", is_sample, credits_reserved }
POST /v1/verify/emaildata:writeVerify one email address{ email, wait_s?: 0–25 (default 5) }200 when answered, else 202: a batch with `result` (null while it runs)
POST /v1/verify/emailsdata:writeVerify up to 5,000 email addresses{ items: string[], wait_s?, webhook_url? }200 when done, else 202: the batch (+ webhook_secret once)

Phones

Look up and reverse phone numbers, check lines, find direct phones, and read their status.

EndpointScopeWhat it doesInputReturns
POST /v1/data/find-phonedata:writeFind a direct phone{ person: {linkedin_url} | {email} }202, as verify-email
POST /v1/data/verify-phonedata:writeCheck a phone line (mobile, landline, VoIP){ phone } (with country code; 10 digits read as US)202, as verify-email
GET /v1/phone/levelsdata:readWhich lookup levels are available, and their credits{ levels: [{ level, available, reason, credits, reverse }], reverse: { available, use_accepted, use_line, default_level }, max_items }
POST /v1/phone/lookupdata:writeLook up one phone number{ phone, level?: "validate" | "name" | "enhanced" | "identity", default_country?, wait_s? }200 when answered, else 202: { id, status: queued | running | done | failed, result, cost: { credits } }
GET /v1/phone/lookup/:iddata:readOne phone lookup: status, result and costthe lookup
POST /v1/phone/lookupsdata:writeLook up up to 5,000 phone numbers{ items, level?, default_country?, max_credits?, wait_s? }200 when done, else 202: the batch (total, done, found, no_match, failed, credits_used, progress)
GET /v1/phone/lookups/:iddata:readA phone lookup list: progress and a page of results?cursor=<index>&limit=1–1000the batch
GET /v1/phone/lookups/:id/exportdata:readA phone lookup list as CSVtext/csv
POST /v1/phone/reversedata:writeWho is behind one phone number{ phone, level?: "name" | "enhanced" | "identity", accept_use?, default_country?, wait_s? }200 / 202: the lookup, with result.match { status: matched | inferred, confidence, person, company }
POST /v1/phone/reversesdata:writeWho is behind up to 5,000 phone numbers{ items, level?, accept_use?, default_country?, max_credits?, wait_s? }200 / 202: the batch
POST /v1/verify/phonedata:writeCheck one phone number{ phone, default_country?, checks?: ["format" | "line_type"], wait_s? }200 / 202: a batch with `result`
POST /v1/verify/phonesdata:writeCheck up to 5,000 phone numbers{ items, default_country?, checks?, wait_s?, webhook_url? }200 / 202: the batch

People and companies enrichment

Enrich lists of people and companies, match LinkedIn profiles, and find contacts.

EndpointScopeWhat it doesInputReturns
POST /v1/data/find-contactsdata:writeRun find_contacts as a job{ args } (the find_contacts tool arguments)202 { job_id, status: "queued" }
GET /v1/data/find-contacts/:iddata:readA find_contacts job{ id, status, rows, pending_job_ids, result_line, is_sample, reason }
POST /v1/data/match-linkedindata:writeEmail to LinkedIn profile{ email }202, as verify-email
POST /v1/enrich/companiesdata:writeEnrich up to 5,000 companies{ items: (string | {domain} | {name})[], wait_s?, webhook_url? }200 / 202: the batch (kind company)
POST /v1/enrich/peopledata:writeEnrich up to 5,000 people{ items: (string | {full_name | first_name + last_name, company | domain} | {email} | {linkedin_url})[], want?: ("email" | "phone" | "linkedin")[], wait_s?, webhook_url? }200 / 202: the batch (kind person)

Batches and files

Upload CSV or .xlsx files, follow batch progress, page results and export them.

EndpointScopeWhat it doesInputReturns
GET /v1/enrich/batches/:iddata:readSame as /v1/verify/batches/:idthe batch
POST /v1/enrich/batches/:id/download-linkdata:readSame as /v1/verify/batches/:id/download-link{ url, expires_at, format, file_name }
GET /v1/enrich/batches/:id/exportdata:readSame as /v1/verify/batches/:id/exporttext/csv
POST /v1/enrich/uploaddata:writeEnrich a CSV or .xlsx fileas /v1/verify/upload, with kind?: people | companies and want?200 / 202: the batch with `upload`
GET /v1/verify/batches/:iddata:readBatch progress and a page of results?cursor=<index>&limit=1–1000the batch
POST /v1/verify/batches/:id/download-linkdata:readA one-hour download link to the results{ url, expires_at, format, file_name }: the results in the format the list came in, no auth header needed
GET /v1/verify/batches/:id/exportdata:readBatch results as a filetext/csv (or ?format=xlsx): the original columns plus the result columns; ?columns=simple: Status (label), Grade, Reason
POST /v1/verify/uploaddata:writeVerify a CSV or .xlsx file (≤ 5,000 rows)multipart `file` (+ kind?: emails | phones, default_country?, checks?, webhook_url?, wait_s?), or JSON { csv | xlsx_base64, file_name?, kind? }, or a raw text/csv body200 / 202: the batch with `upload` (the columns found)

Lookups

Every paid lookup you ran, with its result and what it cost.

EndpointScopeWhat it doesInputReturns
GET /v1/data/lookupsdata:readYour lookups, newest first?limit=1–200 (default 50)&cursor={ items, next_cursor }
GET /v1/data/lookups/:iddata:readOne lookup and its result{ id, action, status, is_sample, input, result, credits: { charged, state, reason } }

Credits and plan

Credits left, usage by key and app, plan limits and plans.

EndpointScopeWhat it doesInputReturns
GET /v1/billingworkspace:readList billing
GET /v1/billing/addonsworkspace:readBilling › addons
GET /v1/billing/charge-decisiondata:readBilling › charge decision
GET /v1/billing/guaranteeworkspace:readBilling › guarantee
GET /v1/billing/plan-limitsworkspace:readBilling › plan limits
GET /v1/creditsdata:readThe credit wallet: included, rolled over, bought, used, left{ metered, included, rollover, bought, used, reserved, left, packs, next_pack, prices }
GET /v1/credits/usagedata:readThis month's credits by person, API key and connected app, by action, and per day{ period, included, used, reserved, left, pct, resets_at, by_principal: [{ principal, label, kind, credits, by_action }], daily: [{ day, credits }] }
GET /v1/data/creditsdata:readCredits left this month and the price per action{ metered, allowance, rollover, used, reserved, left, resets_at, packs, prices }
GET /v1/mcp-planspublicThe MCP plans and their prices (public){ plans, mcp_url }
GET /v1/planleads:readYour plan and its limitsthe plan
GET /v1/planspublicThe plans and their prices (public){ plans }
GET /v1/usageworkspace:readThis month's usage against your planthe usage

Web search, news and competitors

Search our company web index, read company news and scored competitors with their evidence.

EndpointScopeWhat it doesInputReturns
GET /v1/companies/:id/competitorsagents:read outboundA company's scored competitors with their evidence?limit=1–50&include_inferred=true|false{ company, items: [{ company_id, name, domain, score, passes, inferred, why, evidence }], computed_at, stale, reason }
GET /v1/companies/:id/newsleads:read outboundA company's recent news, each item with its link and date?since=&limit=1–100{ company, items: [{ url, title, publisher, date, source, inferred, why }], fetched_at, stale, reason }
GET /v1/competitorsagents:readList competitors
POST /v1/competitorsagents:writeCreate a competitor
GET /v1/competitors/:idagents:readGet a competitor
PATCH /v1/competitors/:idagents:writeUpdate a competitor
PUT /v1/competitors/:id/policyagents:writeUpdate: Competitor › policy
POST /v1/competitors/:id/policy/evaluateagents:writeCompetitor › policy evaluate
POST /v1/competitors/discoveragents:writeCompetitors › discover
GET /v1/search/webleads:read outboundSearch our company web index and news?q=&intent=news|competitors|company|general&company_id=|domain=&since=&limit=1–20{ items: [{ url, title, description, date, date_kind, kind, source, inferred }], own, stale, sample, refresh_hint, reason }
POST /v1/search/web/refreshleads:write outboundLook further for news or competitors (runs as a job){ intent, q?, company_id?, domain? }202 { job_id, status } — progress on GET /v1/jobs/{id}

Technologies

Companies by the technology their websites use, and site profiles from our own crawl.

EndpointScopeWhat it doesInputReturns
GET /v1/data/companies/:domain/technographicsdata:readTechnologies named in a company's job posts (inferred) and, as a separate list, seen on its website?source=jobs|site|all{ company, source, jobs, jobs_reason, site, site_reason, credits_charged }
GET /v1/data/tech/catalogdata:readThe technology catalog: parent categories, categories, every technology and how many sites use it now?category=&parent_category=&q={ version, parents, categories, techs, sites_note }
GET /v1/data/tech/sitesdata:readCompanies whose websites use a technology (our own crawl: page code, headers, DNS, files)?tech=magento,stripe&match=any|all&not=&category=&parent_category=&channel=&status=current|gone|any&since=YYYY-MM-DD&country=US&region=FL&limit=1–100&cursor={ items: [{ domain, company, company_reason, techs: [{ tech, name, category, parent_category, channel, version, matched, status, first_seen, last_seen, inferred, evidence }] }], next_cursor, resolved, not, match, credits_charged }
GET /v1/site-profilesignals:readList site profile
GET /v1/technographics/catalogagents:readTechnographics › catalog

Jobs

Job posts from companies' own public job boards and careers pages, and what one company is hiring for.

EndpointScopeWhat it doesInputReturns
GET /v1/data/companies/:domain/hiringdata:readWhat a company is hiring for: open posts, posts in the last 30 days, by function and seniority, its newest posts and the boards we read{ company, read_at, reason, num_jobs, num_jobs_last_30_days, num_jobs_closed_last_30_days, by_function, by_seniority, newest, boards, credits_charged }
GET /v1/data/jobsdata:readJob posts from companies' own public job boards and careers pages (our own dataset), newest first?q=&title=&function=sales,marketing&seniority=&tech=snowflake&country=US&state=TX&city=&remote=true|false&salary_min=&posted_since=YYYY-MM-DD&status=open|closed|any&company_domain=&company_id=&limit=1–100&cursor={ items: [{ id, url, job_title, function, seniority, description, status, date_posted, location fields, remote, salary fields, technologies, evidence: { url, date_posted }, company, company_reasons }], next_cursor, credits_charged }
GET /v1/data/jobs/:iddata:readOne job post with its full description{ …the post, credits_charged }

Search people and companies, reveal contact details, save searches, contacts and lookalike companies.

EndpointScopeWhat it doesInputReturns
GET /v1/championsleads:readList champions
POST /v1/champions/importleads:writeChampions › import
GET /v1/contactsleads:readList your contacts?q=&limit=&cursor={ items, next_cursor }
GET /v1/contacts/:idleads:readGet a contactthe contact
PUT /v1/contacts/:id/tagsleads:writeUpdate: Contact › tags
GET /v1/data-coveragesignals:readList data coverage
GET /v1/data-qualityleads:readList data quality
GET /v1/data-requestsleads:readList data requests
POST /v1/data-requestsleads:writeCreate a data request
GET /v1/data-requests/:idleads:readGet a data request
POST /v1/data-requests/:id/cancelleads:writeData request › cancel
GET /v1/data-requests/:id/resultsleads:readData request › results
POST /v1/data-requests/:id/runleads:writeData request › run
GET /v1/lookalikessignals:readList lookalike runs{ items }
POST /v1/lookalikessignals:writeFind companies like your best ones (runs as a job){ seed_domains?, seed_company_ids?, agent_id?, filters? }202 the run
GET /v1/lookalikes/:idsignals:readA lookalike run and its graded companies?grade=A,B&limit=&offset=the run with its results
GET /v1/network/insightsleads:readNetwork › insights
POST /v1/search/add-to-agentleads:write outboundSearch › add to agent
GET /v1/search/companiessignals:read outboundSearch companies?q=&industries=&sizes=&locations=&technologies=&limit=1–200&cursor={ items, next_cursor, total }
GET /v1/search/companies/matchsignals:read outboundMatch a company by name or domainthe matched companies
POST /v1/search/companies/matchsignals:read outboundMatch a list of companies by name or domainthe matched companies
GET /v1/search/databasesignals:read outboundSearch › database
POST /v1/search/databasesignals:read outboundSearch › database
GET /v1/search/detailsignals:read outboundSearch › detail
GET /v1/search/exportsignals:read outboundSearch results as CSVtext/csv
POST /v1/search/find-contactleads:write outboundSearch › find contact
POST /v1/search/find-emailleads:write outboundFind the verified email of a search result (runs as a job)202 { progress_id }
POST /v1/search/find-phoneleads:write outboundFind the phone of a search result (runs as a job)202 { progress_id }
GET /v1/search/leadssignals:read outboundFind leads: people or companies with recent buying signals?kind=people|companies&q=&titles=&industries=&sizes=&locations=&signal_types=&since_days=1–365&limit=1–100&cursor={ items, next_cursor }
POST /v1/search/liveleads:write outboundRun a live people or company search (runs as a job)202 { job_id, progress_id, preview }
POST /v1/search/live/previewsignals:read outboundCost preview of a live people or company search (nothing spent)the preview
GET /v1/search/marketsignals:read outboundSearch › market
POST /v1/search/marketsignals:read outboundSearch the market database (cost preview, then confirm)without confirm: the preview; with confirm: 202 { job_id, progress_id }
POST /v1/search/market/previewsignals:read outboundCost preview of a market database search (nothing spent)the preview
GET /v1/search/peoplesignals:read outboundSearch people?q=&titles=&seniority=&departments=&industries=&sizes=&locations=&limit=1–200&cursor={ items, next_cursor, total }
POST /v1/search/people/:id/add-to-agentleads:write outboundSearch › people add to agent
GET /v1/search/people/:id/enrichsignals:readSearch › people enrich
POST /v1/search/people/:id/enrichsignals:read outboundSearch › people enrich
POST /v1/search/people/:id/send-emailleads:write outboundSearch › people send email
PUT /v1/search/people/:id/tagsleads:writeUpdate: Search › people tags
POST /v1/search/push-crmleads:write outboundSearch › push CRM
POST /v1/search/revealleads:write outboundReveal emails or mobiles for search results (cost preview first){ person_ids, fields: ["email" | "mobile"], confirm?, max_lookups? }without confirm: the cost preview; with confirm: 202 { job_id, progress_id, preview }
GET /v1/search/savedleads:readList saved searches{ items }
POST /v1/search/savedleads:writeSave a search{ name, kind, filters }201 the saved search
DELETE /v1/search/saved/:idleads:writeDelete: Search › saved (one)
GET /v1/search/saved/:idleads:readSearch › saved (one)
PATCH /v1/search/saved/:idleads:writeUpdate: Search › saved (one)
POST /v1/search/selectionsignals:read outboundSearch › selection
POST /v1/search/verify-emailleads:write outboundVerify one email from search (runs as a job){ email }202 { progress_id, is_sample }
GET /v1/taxonomy/nichesagents:readTaxonomy › niches

Signals

Buying signals behind your leads, the signal library, custom signals, saved signal searches, multi-signal rules, and your product events.

EndpointScopeWhat it doesInputReturns
GET /v1/account-listssignals:readList your account lists, each with its signals and its progress{ items, limits: { accounts: { used, limit }, lists: { used, limit } } }
POST /v1/account-listssignals:write outboundMake an account list{ name }201 the list with created
DELETE /v1/account-lists/:idsignals:writeDelete an account list (never "My accounts"); its accounts stay on "My accounts"{ deleted, id, name, accounts }
PATCH /v1/account-lists/:idsignals:writeRename an account list (never "My accounts"){ name }the list
POST /v1/account-lists/:id/memberssignals:write outboundAdd accounts to a list by domain: a paste or a file (checked against its signals as a job). Also needs watchlist:write{ domains } or { csv } or { rows }202 { added, duplicates, invalid, accounts, checking }
PUT /v1/account-lists/:id/signal-setsignals:write outboundPick the signal set a list takes its signals from, or null for its own{ signal_set_id: uuid | null }the list with checking
PUT /v1/account-lists/:id/signalssignals:write outboundSet the signals a list is checked against (the whole set){ signals: [{ custom_signal_id, priority?, on? }] }the list with checking
PUT /v1/account-lists/:id/suggestionssignals:writeKeep finding accounts for a list (on or off) and what a suggestion must fit{ on?, filters?: { since_days, sizes, industries, locations } }{ on, filters, effective_filters, filters_from, filters_line, high_signals, new_this_week, open, per_day, running, last_run_at, reason }
POST /v1/account-lists/:id/suggestions/watchsignals:write outboundWatch several suggested accounts at once (refused whole past the plan). Also needs watchlist:write{ ids } or { top }{ watched, domains, accounts, checking }
GET /v1/accountssignals:readList accounts: score with its parts, Why now, signals true, newest evidence, owner and list?list_id=&q=&sort=added|score&tab=watching|ruled_out&limit=&cursor={ items, next_cursor, total, list, progress, tabs }
DELETE /v1/accounts/:idsignals:writeTake an account off its list; off "My accounts" it leaves every list and the watchlist. Also needs watchlist:write{ removed, domain, everywhere, lists, accounts }
GET /v1/accounts/:idsignals:readOne account: its score and Why now, a line per signal with its evidence link and date or the reason it has none, and what we readthe account with lines and reads
PATCH /v1/accounts/:idsignals:write outboundCorrect an account's domain. Also needs watchlist:write{ domain }the account with lines
POST /v1/accounts/:id/answers/:customSignalId/feedbacksignals:write"Not right?": rate the answer one signal gave for this account (good, bad, or null to clear){ verdict, reason? }{ custom_signal_id, rating, reason, rated_at, line }
POST /v1/accounts/:id/leadleads:write outboundMake a lead from an account (queued as a job; every lead check applies)202 { queued, via, evidence, line }
POST /v1/accounts/:id/rejectsignals:writeReject a suggested account: never suggested again; names the filter that fixes the reason{ reason, note? }{ rejected, id, domain, reason, reason_label, suggest_edit, company_size, proposed_filters, filters }
POST /v1/accounts/:id/watchsignals:write outboundWatch a suggested account: it joins its list and the watchlist and is checked against the list's signals. Also needs watchlist:write{ watched, id, domain, list_id, accounts, already, checking }
GET /v1/accounts/outcomessignals:readYour won and lost deals on file (add them with POST /v1/imports kind "outcomes")?limit={ won, lost, items, empty_reason }
POST /v1/accounts/outcomessignals:writeAdd won and lost deals one by one (then "My accounts" is tested again){ deals: [{ domain, outcome: won | lost, date: YYYY-MM-DD, value?, currency? }] (≤ 5,000) }{ added, invalid: [{ index, reason }], notes, testing } (each deal kept counts against the monthly import allowance)
GET /v1/accounts/overviewsignals:readOne of your accounts by its domain: score, Why now with quotes, a line per signal, what we read?domain=acme.comthe account as GET /v1/accounts/:id; 404 when the domain is not one of your accounts
GET /v1/accounts/prioritiessignals:readToday's top accounts: the Accounts screen's order, only those with a score, each Why now fact with its date, link and quote?limit= (1-25, default 10){ items (the account rows of GET /v1/accounts, story.clauses with quote and quote_url), reason, list, tabs, progress }
GET /v1/custom-signalssignals:readList custom signals{ items, limit, library_limit, room: { used, limit }, tries_left_today }
POST /v1/custom-signalssignals:writeDescribe a custom signal in one sentence (built as a job){ description, agent_id?, auto_lead?, leads_per_day?, scope?, list_ids? }202 { id, status: "compiling", progress_id }; a signal limited to account lists adds { scope: "lists", list_ids, scope_note? }
DELETE /v1/custom-signals/:idsignals:writeDelete a custom signal
GET /v1/custom-signals/:idsignals:readA custom signal, its latest hits and runsthe custom signal
PATCH /v1/custom-signals/:idsignals:writeUpdate a custom signal
POST /v1/custom-signals/:id/activatesignals:writeCustom signal › activate
PUT /v1/custom-signals/:id/alertssignals:writeSet where a signal sends its matches, or mute it{ muted?, deliver?: { slack?, email?, webhook?, when?: "at_once" | "morning" } | null }the custom signal with muted and deliver
GET /v1/custom-signals/:id/backtest/dealssignals:readThe won or lost deals a signal came before, each with its dated proof?outcome=won|lost&list_id={ outcome, with, total, excluded, reason, items: [{ domain, name, occurred_on, value, currency, proof: { url, date, title, quote } }] }
GET /v1/custom-signals/:id/hitssignals:readCustom signal › hits
POST /v1/custom-signals/:id/hits/:customSignalHitId/feedbacksignals:writeCustom signal › hits feedback
POST /v1/custom-signals/:id/improvesignals:writeCustom signal › improve
GET /v1/custom-signals/:id/outcomessignals:readOne signal's results and suggested priority{ custom_signal_id, leads, sent, meetings, line, reason, own, network, suggested, window }
POST /v1/custom-signals/:id/pausesignals:writeCustom signal › pause
GET /v1/custom-signals/backtestsignals:readWhat predicts wins: per signal, the won and lost deals it came before and its matches in 12 months?list_id={ list, deals: { won, lost }, empty_reason, progress, coverage_line, items: [{ custom_signal_id, name, priority, wins, losses, matches, suggested, limit, quiet }] }
POST /v1/custom-signals/backtestsignals:writeTest signals on the last 12 months of a list's accounts (runs as a job){ list_id? } ("My accounts" when left out)202 { status: "queued" | "running", progress_id, list_id }; 200 { status: "done" } when the same test already ran today; 409 when no signal is on, paused or saved
GET /v1/custom-signals/outcomessignals:readSignal results: per signal the leads, sends, positive replies, meetings and wins in the latest window, and a suggested priority{ window, computed_at, needed_sends, average, network: { on, reason }, items: [{ custom_signal_id, leads, sent, positive_replies, meetings, won, line, reason, own, network, suggested }] }
POST /v1/custom-signals/tryoutssignals:writeTry up to five sentences before anything is saved (read and counted as a job){ sentences, context? }202 { items: [{ sentence, id, status: "queued", progress_id } | { sentence, existing_id, existing_status }], tries_left_today }
GET /v1/custom-signals/tryouts/:idsignals:readA tried sentence: how it was read, its 30-day count and example companiesthe tryout
GET /v1/custom-signals/tryouts/:id/backtestsignals:readA tried sentence's history test: matches in 12 months and the wins it came before{ tryout_id, progress, deals, result, result_reason }
POST /v1/custom-signals/tryouts/:id/backtestsignals:writeTest a tried sentence on the last 12 months (runs as a job)202 { status, progress_id, tryout_id }
GET /v1/custom-signals/tryouts/:id/backtest/dealssignals:readThe won or lost deals a tried sentence came before, each with its dated proof?outcome=won|lost{ outcome, with, total, items }
POST /v1/custom-signals/tryouts/:id/keepsignals:writeTurn a tried sentence on as a signal{ auto_lead?, leads_per_day?, priority?, agent_id?, scope?, list_ids? }201 the custom signal with created and first_run_job_id
GET /v1/eventsevents:readList product events?account=&event=&limit=&cursor={ items, next_cursor }
POST /v1/eventsevents:writeSend product events (one or up to 500){ account_domain | company, user_email?, event, properties?, occurred_at? } or { events: [...] }202 the accepted count
GET /v1/events/:idagents:readGet an event
PATCH /v1/events/:idagents:write outboundUpdate an event
GET /v1/events/:id/registrantsagents:readEvent › registrants
GET /v1/events/summaryevents:readProduct events in the last 30 days{ events, today, per_day }
POST /v1/extension/addwatchlist:writeExtension › add
GET /v1/extension/lookupsignals:readExtension › lookup
GET /v1/redditworkspace:readList Reddit
GET /v1/reddit/matchesleads:readReddit › matches
GET /v1/reddit/matches/:idleads:readReddit › matches (one)
GET /v1/reddit/plansworkspace:readReddit › plans
GET /v1/reddit/postedinbox:readReddit › posted
GET /v1/reddit/repliesworkspace:readReddit › replies
GET /v1/signal-alertssignals:readList signal alerts with where each went?custom_signal_id=&limit=&cursor={ items, next_cursor }
POST /v1/signal-alerts/retrysignals:writeSend failed signal alerts again (sent by a job){ channel: "slack" | "webhook" }202 { channel, retried, status: "queued" }
GET /v1/signal-alerts/statussignals:readWhich alert channels are on the plan, connected or failing{ slack, webhook, email, morning_hour, timezone }
GET /v1/signal-jobs/:idsignals:readGet a signal job
GET /v1/signal-librarysignals:readList signal library
POST /v1/signal-library/:key/enablesignals:writeSignal library › enable
GET /v1/signal-library/outcomessignals:readThe network's suggested priority per library signal (only while network learning is on){ network: { on, reason }, items: [{ key, suggested }] }
GET /v1/signal-rulessignals:readList signal rules
POST /v1/signal-rulessignals:writeCreate a signal rule
DELETE /v1/signal-rules/:idsignals:writeDelete a signal rule
GET /v1/signal-rules/:idsignals:readGet a signal rule
PATCH /v1/signal-rules/:idsignals:writeUpdate a signal rule
GET /v1/signal-searchessignals:readList signal searches
POST /v1/signal-searchessignals:writeCreate a signal searche
DELETE /v1/signal-searches/:idsignals:writeDelete a signal searche
GET /v1/signal-searches/:idsignals:readGet a signal searche
PATCH /v1/signal-searches/:idsignals:writeUpdate a signal searche
GET /v1/signal-searches/:id/resultssignals:readSignal searche › results
POST /v1/signal-searches/:id/results/:signalSearchResultId/rejectsignals:writeSignal searche › results reject
POST /v1/signal-searches/:id/results/add-to-agentleads:write outboundSignal searche › results add to agent
POST /v1/signal-searches/:id/runsignals:writeSignal searche › run
POST /v1/signal-searches/estimatesignals:readSignal searches › estimate
GET /v1/signal-searches/optionssignals:readSignal searches › options
GET /v1/signal-setssignals:readList your signal sets, each with its signals and the lists that use it{ items, room: { used, limit } } ("All signals" counts as the first set)
POST /v1/signal-setssignals:writeMake a signal set{ name, signals?: [{ custom_signal_id, priority? }] }201 the set
DELETE /v1/signal-sets/:idsignals:writeDelete a signal set; its lists keep the signals they have{ deleted, id, name, lists }
GET /v1/signal-sets/:idsignals:readOne signal set: its signals with the set's priority and the lists that use itthe set
PATCH /v1/signal-sets/:idsignals:write outboundRename a signal set or replace its signals; every list on it follows (new signals are checked as a job){ name?, signals? }the set with checking
GET /v1/signal-sourcessignals:readList signal sources
GET /v1/signal-suggestionssignals:readList signal suggestions
POST /v1/signal-suggestions/:id/addsignals:writeSignal suggestion › add
POST /v1/signal-suggestions/:id/dismisssignals:writeSignal suggestion › dismiss
POST /v1/signal-suggestions/refreshsignals:writeSignal suggestions › refresh
GET /v1/signalssignals:readBuying signals behind your leads?kind=&since_days=&agent_id={ items }
GET /v1/signals/:idsignals:readGet a signal with its evidence link and datethe signal
GET /v1/signals/catalogsignals:readSignals › catalog
PATCH /v1/signals/catalogagents:writeUpdate: Signals › catalog
GET /v1/site-monitorswatchlist:readList site monitors

Leads

Read leads with their evidence, approve, reject and edit drafts, tags, tasks, results and exports.

EndpointScopeWhat it doesInputReturns
GET /v1/benchmarksleads:readList benchmarks
GET /v1/booking/experimentsleads:readBooking › experiments
GET /v1/booking/funnelleads:readBooking › funnel
GET /v1/deliveriesleads:readList deliveries
GET /v1/deliveries/:id/csvleads:readDelivery › CSV
GET /v1/export/leads.csvleads:readLeads as CSVtext/csv
POST /v1/lead-stops/:id/undoleads:writeLead stop › undo
GET /v1/leadsleads:readList leads?limit=&cursor=&agent_id=&status=&feed_date=today|YYYY-MM-DD&signal_type=&q={ items, next_cursor, is_sample? }
GET /v1/leads/:idleads:readGet a lead: company, person, evidence, fit and draftthe lead
POST /v1/leads/:id/approveleads:write outboundApprove a lead for sending{ id, status: "approved" | "writing", reason? } ("writing": approved once its email passes review)
POST /v1/leads/:id/contactleads:writeLead › contact
POST /v1/leads/:id/creditleads:writeLead › credit
POST /v1/leads/:id/draft-feedbackleads:writeLead › draft feedback
POST /v1/leads/:id/draftsleads:writeSave an edited draft{ subject, body, followup_1, followup_2 }201 the draft version
GET /v1/leads/:id/emailsleads:readLead › emails
PUT /v1/leads/:id/emails/:nleads:writeUpdate: Lead › emails (one)
POST /v1/leads/:id/emails/:n/adviceleads:writeLead › emails advice
POST /v1/leads/:id/emails/:n/holdleads:writeLead › emails hold
POST /v1/leads/:id/emails/:n/resumeleads:writeLead › emails resume
POST /v1/leads/:id/emails/:n/rewriteleads:writeLead › emails rewrite
PATCH /v1/leads/:id/emails/:n/scheduleleads:writeUpdate: Lead › emails schedule
POST /v1/leads/:id/emails/ownleads:write outboundLead › emails own
POST /v1/leads/:id/feedbackleads:writeLead › feedback
POST /v1/leads/:id/linkedin-matchleads:writeLead › LinkedIn match
GET /v1/leads/:id/next-actionleads:readLead › next action
POST /v1/leads/:id/next-actionleads:writeLead › next action
GET /v1/leads/:id/notesleads:readLead › notes
POST /v1/leads/:id/notesleads:writeLead › notes
POST /v1/leads/:id/push-crmleads:writeLead › push CRM
POST /v1/leads/:id/redraftleads:writeLead › redraft
POST /v1/leads/:id/rejectleads:writeReject a lead{ reason?, exclude_company? }{ id, status: "rejected" | "stopped", excluded_domain }
POST /v1/leads/:id/rules/:ruleId/correctleads:writeLead › rules correct
GET /v1/leads/:id/sendleads:readLead › send
POST /v1/leads/:id/sendleads:write outboundLead › send
POST /v1/leads/:id/send-nowleads:writeLead › send now
GET /v1/leads/:id/sequenceleads:readLead › sequence
DELETE /v1/leads/:id/sequence/overrideleads:writeDelete: Lead › sequence override
PUT /v1/leads/:id/sequence/overrideleads:writeUpdate: Lead › sequence override
POST /v1/leads/:id/stopleads:writeLead › stop
PUT /v1/leads/:id/tagsleads:writeUpdate: Lead › tags
GET /v1/leads/:id/timelineleads:readLead › timeline
POST /v1/leads/:id/unapproveleads:writeLead › unapprove
GET /v1/leads/:id/voiceleads:readLead › voice
GET /v1/leads/:id/voice/audioleads:readLead › voice audio
POST /v1/leads/:id/voice/previewleads:write outboundLead › voice preview
DELETE /v1/leads/:id/wonleads:writeDelete: Lead › won
GET /v1/leads/:id/wonleads:readLead › won
POST /v1/leads/:id/wonleads:writeLead › won
GET /v1/leads/:leadId/conversionleads:readLead › conversion
PATCH /v1/leads/:leadId/followups/:nleads:writeUpdate: Lead › followups (one)
POST /v1/leads/:leadId/followups/:n/cancelleads:writeLead › followups cancel
POST /v1/leads/:leadId/followups/:n/holdleads:writeLead › followups hold
POST /v1/leads/:leadId/followups/:n/resumeleads:writeLead › followups resume
POST /v1/leads/:leadId/linkedinleads:write outboundLead › LinkedIn
POST /v1/leads/bulk-approveleads:write outboundApprove many leads at once{ lead_ids } or { filter: { min_fit, feed_date?, agent_id? } }202 { job_id, accepted, skipped }
GET /v1/leads/countersleads:readLeads › counters
GET /v1/leads/stage-countsleads:readLeads › stage counts
GET /v1/leads/view-countsleads:readLeads › view counts
POST /v1/learning/:id/undoagents:writeLearning › undo
GET /v1/meetingsleads:readList meetings
POST /v1/meetings/:id/outcomeleads:writeMeeting › outcome
GET /v1/queuedleads:readQueued first emails: scheduled, not scheduled yet, on hold?state=all|scheduled|not_scheduled|held&agent_id=&cursor={ items, counts: { waiting, scheduled, not_scheduled, held }, next_cursor }
POST /v1/queued/bulkleads:writeHold, resume or send back to review{ lead_ids, action: hold | resume | to_review }{ done, skipped }
POST /v1/queued/scheduleleads:write outboundQueued › schedule
GET /v1/resultsleads:readList results
GET /v1/results/channelsleads:readResults › channels
GET /v1/results/dailyleads:readResults › daily
GET /v1/results/seriesleads:readResults › series
GET /v1/results/signal-valueleads:readResults › signal value
GET /v1/results/weeklyleads:readResults › weekly
GET /v1/stats/todayleads:readToday's numbers?period=24h|7d|30d&agent_id=the stats
GET /v1/tag-rulesleads:readList tag rules
POST /v1/tag-rulesleads:write outboundCreate a tag rule
DELETE /v1/tag-rules/:idleads:writeDelete a tag rule
GET /v1/tag-rules/:idleads:readGet a tag rule
PATCH /v1/tag-rules/:idleads:write outboundUpdate a tag rule
GET /v1/tagsleads:readList tags{ items, colors }
POST /v1/tagsleads:writeCreate a tag{ name, color? }201 the tag
DELETE /v1/tags/:idleads:writeDelete a tag
PATCH /v1/tags/:idleads:writeUpdate a tag
POST /v1/tags/:id/contactsleads:writeTag › contacts
POST /v1/tags/:id/leadsleads:writeTag › leads
POST /v1/tags/:id/peopleleads:writeTag › people
GET /v1/tasksleads:readList tasks
POST /v1/tasks/:id/doneleads:writeTask › done
POST /v1/tasks/:id/skipleads:writeTask › skip
GET /v1/testsleads:readList tests
GET /v1/whats-workingleads:readList what's working

Lists

Watchlist, imports and exclusions.

EndpointScopeWhat it doesInputReturns
GET /v1/exclusionsexclusions:readList exclusions?kind=&q=&limit=&cursor={ items, next_cursor, total }
POST /v1/exclusionsexclusions:writeExclude domains or emails (never contacted){ items: [{ kind, value, reason }] } or { domains, emails, reason }{ added, duplicates, invalid, stopped_leads }
DELETE /v1/exclusions/:idexclusions:writeDelete an exclusion
PATCH /v1/exclusions/:idexclusions:writeUpdate an exclusion
POST /v1/exclusions/checkexclusions:readExclusions › check
GET /v1/exclusions/crmexclusions:readExclusions › CRM
GET /v1/exclusions/exportexclusions:readExclusions as CSVtext/csv
GET /v1/exclusions/summaryexclusions:readExclusions › summary
GET /v1/importsimports:readList imports?kind=&limit=&cursor={ items, next_cursor }
POST /v1/importsimports:write outboundImport a list (CSV upload or rows)multipart (kind: work | watchlist | exclusions | seeds | outcomes, agent_id?, file), raw text/csv + ?kind=, or JSON { kind, csv | rows }202 the import
GET /v1/imports/:idimports:readGet an import and its summarythe import
POST /v1/imports/:id/enrichimports:writeEnrich an import's rows (estimate first with dry_run){ fields, agent_id?, row_ids?, dry_run? }dry_run: { estimate }; else 202 the run
GET /v1/imports/:id/rowsimports:readAn import's rows?limit=&cursor=&row_bucket={ items, next_cursor }
POST /v1/switch/leadsimports:writeSwitch › leads
POST /v1/switch/leads/previewimports:writeSwitch › leads preview
POST /v1/switch/sequenceagents:writeSwitch › sequence
GET /v1/switch/sequencesagents:readSwitch › sequences
GET /v1/switch/sequences/:idagents:readSwitch › sequences (one)
GET /v1/watchlistwatchlist:readList watched companies?limit=&cursor=&q=&agent_id={ items, next_cursor, total }
POST /v1/watchlistwatchlist:write outboundWatch companies by domain{ domains, agent_id }{ added, duplicates, invalid }
DELETE /v1/watchlist/:idwatchlist:writeStop watching a company{ ok: true }

Agents

Agents: who to target, which signals to watch, plays, personas and the content library.

EndpointScopeWhat it doesInputReturns
GET /v1/agentsagents:readList agents{ items }
POST /v1/agentsagents:write outboundCreate an agent from a domain or one sentence{ input, name? }201 the agent (its profile builds in a job)
POST /v1/agents/:agentId/buildagents:write outboundAgent › build
PUT /v1/agents/:agentId/laneagents:writeUpdate: Agent › lane
GET /v1/agents/:agentId/linkedin/introsagents:readAgent › LinkedIn intros
POST /v1/agents/:agentId/linkedin/introsagents:write outboundAgent › LinkedIn intros
DELETE /v1/agents/:agentId/linkedin/intros/:idagents:writeDelete: Agent › LinkedIn intros (one)
GET /v1/agents/:agentId/linkedin/intros/:idagents:readAgent › LinkedIn intros (one)
GET /v1/agents/:agentId/linkedin/networkagents:readAgent › LinkedIn network
POST /v1/agents/:agentId/linkedin/network/scanagents:write outboundAgent › LinkedIn network scan
GET /v1/agents/:agentId/linkedin/searchesagents:readAgent › LinkedIn searches
POST /v1/agents/:agentId/linkedin/searchesagents:write outboundAgent › LinkedIn searches
DELETE /v1/agents/:agentId/linkedin/searches/:idagents:writeDelete: Agent › LinkedIn searches (one)
POST /v1/agents/:agentId/niche-packs/:key/applyagents:writeAgent › niche packs apply
GET /v1/agents/:agentId/podsagents:readAgent › pods
GET /v1/agents/:agentId/pods/:idagents:readAgent › pods (one)
PATCH /v1/agents/:agentId/pods/:idagents:writeUpdate: Agent › pods (one)
POST /v1/agents/:agentId/pods/:id/approveagents:writeAgent › pods approve
POST /v1/agents/:agentId/pods/:id/dismissagents:writeAgent › pods dismiss
POST /v1/agents/:agentId/pods/:id/messaging/regenerateagents:writeAgent › pods messaging regenerate
POST /v1/agents/:agentId/pods/:id/pauseagents:writeAgent › pods pause
POST /v1/agents/:agentId/pods/:id/resumeagents:writeAgent › pods resume
GET /v1/agents/:agentId/pods/:id/signalsagents:readAgent › pods signals
GET /v1/agents/:agentId/pods/:id/styleagents:readAgent › pods style
GET /v1/agents/:agentId/pods/:id/whats-workingagents:readAgent › pods what's working
GET /v1/agents/:agentId/pods/historyagents:readAgent › pods history
POST /v1/agents/:agentId/pods/ideateagents:writeAgent › pods ideate
POST /v1/agents/:agentId/positioning/variants/:positioningVariantId/approveagents:writeAgent › positioning variants approve
POST /v1/agents/:agentId/positioning/variants/:positioningVariantId/dismissagents:writeAgent › positioning variants dismiss
GET /v1/agents/:agentId/seedsagents:readAgent › seeds
POST /v1/agents/:agentId/seedsagents:writeAgent › seeds
DELETE /v1/agents/:agentId/seeds/:seedIdagents:writeDelete: Agent › seeds (one)
GET /v1/agents/:agentId/segmentsagents:readAgent › segments
PATCH /v1/agents/:agentId/segments/:idagents:writeUpdate: Agent › segments (one)
POST /v1/agents/:agentId/segments/:id/approveagents:writeAgent › segments approve
POST /v1/agents/:agentId/segments/:id/dismissagents:writeAgent › segments dismiss
POST /v1/agents/:agentId/segments/:id/offagents:writeAgent › segments off
POST /v1/agents/:agentId/segments/:id/onagents:writeAgent › segments on
POST /v1/agents/:agentId/segments/:id/unapproveagents:writeAgent › segments unapprove
DELETE /v1/agents/:idagents:writeDelete an agent{ ok: true }
GET /v1/agents/:idagents:readGet an agentthe agent
PATCH /v1/agents/:idagents:writeUpdate an agentany of { name, offer, icp, topics, signal_kinds, daily_volume, mode, review_mode, tone }the agent
GET /v1/agents/:id/activityagents:readAgent › activity
GET /v1/agents/:id/autopilotagents:readAgent › autopilot
PUT /v1/agents/:id/autopilotagents:write outboundUpdate: Agent › autopilot
POST /v1/agents/:id/autopilot/dry-runagents:writeAgent › autopilot dry run
GET /v1/agents/:id/descriptionagents:readAgent › description
PUT /v1/agents/:id/descriptionagents:writeUpdate: Agent › description
POST /v1/agents/:id/duplicateagents:write outboundAgent › duplicate
GET /v1/agents/:id/eventsagents:readAgent › events
POST /v1/agents/:id/eventsagents:write outboundAgent › events
POST /v1/agents/:id/events/importagents:writeAgent › events import
POST /v1/agents/:id/icp/confirmagents:writeAgent › ICP confirm
POST /v1/agents/:id/icp/proposalagents:writeAgent › ICP proposal
GET /v1/agents/:id/learningagents:readAgent › learning
GET /v1/agents/:id/linkedin-engagementworkspace:readAgent › LinkedIn engagement
GET /v1/agents/:id/list-syncsagents:readAgent › list syncs
GET /v1/agents/:id/needsagents:readAgent › needs
PUT /v1/agents/:id/needsagents:writeUpdate: Agent › needs
GET /v1/agents/:id/overviewagents:readAgent › overview
POST /v1/agents/:id/pauseagents:writeAgent › pause
GET /v1/agents/:id/personasagents:readAgent › personas
POST /v1/agents/:id/personasagents:writeAgent › personas
POST /v1/agents/:id/personas/generateagents:writeAgent › personas generate
GET /v1/agents/:id/planleads:readAgent › plan
GET /v1/agents/:id/playsagents:readAgent › plays
PATCH /v1/agents/:id/plays/:playIdagents:write outboundUpdate: Agent › plays (one)
GET /v1/agents/:id/positioningagents:readAgent › positioning
POST /v1/agents/:id/positioning/checkagents:writeAgent › positioning check
GET /v1/agents/:id/previewagents:readAgent › preview
POST /v1/agents/:id/resumeagents:write outboundAgent › resume
GET /v1/agents/:id/sequenceagents:readAgent › sequence
PUT /v1/agents/:id/sequenceagents:writeUpdate: Agent › sequence
GET /v1/agents/:id/sequence/armsagents:readAgent › sequence arms
POST /v1/agents/:id/sequence/armsagents:writeAgent › sequence arms
PUT /v1/agents/:id/sequence/arms/:sequenceArmIdagents:writeUpdate: Agent › sequence arms (one)
POST /v1/agents/:id/sequence/arms/setupagents:writeAgent › sequence arms setup
POST /v1/agents/:id/sequence/previewleads:writeAgent › sequence preview
GET /v1/agents/:id/sequence/statsagents:readAgent › sequence stats
GET /v1/agents/:id/sequence/steps/:stepId/leadsleads:readAgent › sequence steps leads
POST /v1/agents/:id/signal-kinds/dropagents:writeAgent › signal kinds drop
GET /v1/agents/:id/technographicsagents:readAgent › technographics
PATCH /v1/agents/:id/voiceagents:write outboundUpdate: Agent › voice
GET /v1/agents/:id/voice/emailagents:readAgent › voice email
PATCH /v1/agents/:id/voice/emailagents:write outboundUpdate: Agent › voice email
PUT /v1/agents/:id/writingagents:writeUpdate: Agent › writing
GET /v1/audience/customersagents:readAudience › customers
GET /v1/audience/podsagents:readAudience › pods
GET /v1/audience/pods/:idagents:readAudience › pods (one)
POST /v1/audience/pods/:id/approveagents:writeAudience › pods approve
POST /v1/audience/pods/:id/dismissagents:writeAudience › pods dismiss
POST /v1/audience/pods/:id/unapproveagents:writeAudience › pods unapprove
GET /v1/audience/profilesagents:readAudience › profiles
POST /v1/audience/refreshagents:writeAudience › refresh
PATCH /v1/event-guests/:idagents:writeUpdate an event guest
GET /v1/libraryagents:readList library
POST /v1/library/offersagents:writeLibrary › offers
DELETE /v1/library/offers/:idagents:writeDelete: Library › offers (one)
PATCH /v1/library/offers/:idagents:writeUpdate: Library › offers (one)
POST /v1/library/stylesagents:writeLibrary › styles
DELETE /v1/library/styles/:idagents:writeDelete: Library › styles (one)
PATCH /v1/library/styles/:idagents:writeUpdate: Library › styles (one)
POST /v1/list-syncsagents:writeCreate a list sync
DELETE /v1/list-syncs/:idagents:writeDelete a list sync
GET /v1/list-syncs/:idagents:readGet a list sync
PATCH /v1/list-syncs/:idagents:writeUpdate a list sync
POST /v1/list-syncs/:id/rowsagents:writeList sync › rows
POST /v1/list-syncs/:id/runagents:writeList sync › run
GET /v1/niche-packsagents:readList niche packs
DELETE /v1/personas/:personaIdagents:writeDelete a persona
PATCH /v1/personas/:personaIdagents:writeUpdate a persona
GET /v1/playsagents:readList plays
PUT /v1/pods/settingsagents:writeUpdate: Pods › settings
GET /v1/scale/copyagents:readScale › copy
GET /v1/scale/tamagents:readScale › tam
GET /v1/sequencesagents:readList sequences
POST /v1/sequences/:sequenceArmId/leadsleads:write outboundSequence › leads
GET /v1/sourcesagents:readList sources
GET /v1/strategiesagents:readList strategies
GET /v1/supervisoragents:readList supervisor
POST /v1/supervisor/actions/:id/undoagents:writeSupervisor › actions undo
GET /v1/verticalsagents:readList verticals
GET /v1/voiceworkspace:readList voice
GET /v1/voice/voicesagents:readVoice › voices

Inbox and sending

Replies, sent email, mailboxes and LinkedIn accounts.

EndpointScopeWhat it doesInputReturns
GET /v1/calendarsworkspace:readList calendars
GET /v1/fleetmailboxes:readList fleet
GET /v1/inboxinbox:readList replies{ items, next_cursor }
GET /v1/inbox/:idinbox:readGet an inbox thread
PATCH /v1/inbox/:idinbox:writeUpdate an inbox thread
POST /v1/inbox/:id/auto-reply/undoinbox:writeInbox thread › auto reply undo
POST /v1/inbox/:id/bookinbox:writeInbox thread › book
PATCH /v1/inbox/:id/draftinbox:writeUpdate: Inbox thread › draft
POST /v1/inbox/:id/forwardinbox:writeInbox thread › forward
POST /v1/inbox/:id/handledinbox:writeInbox thread › handled
POST /v1/inbox/:id/pickinbox:writeInbox thread › pick
POST /v1/inbox/:id/push-crminbox:writeInbox thread › push CRM
POST /v1/inbox/:id/redraftinbox:writeInbox thread › redraft
POST /v1/inbox/:id/sendinbox:writeInbox thread › send
DELETE /v1/inbox/:id/snoozeinbox:writeDelete: Inbox thread › snooze
POST /v1/inbox/:id/snoozeinbox:writeInbox thread › snooze
POST /v1/inbox/:id/taginbox:writeInbox thread › tag
POST /v1/inbox/bulkinbox:writeInbox › bulk
GET /v1/inbox/countsinbox:readInbox › counts
GET /v1/inboxes/offermailboxes:readInboxes › offer
POST /v1/inboxes/ordermailboxes:write outboundInboxes › order
GET /v1/inboxes/ordersmailboxes:readInboxes › orders
GET /v1/inboxes/orders/:idmailboxes:readInboxes › orders (one)
GET /v1/linkedin-accountsworkspace:readList LinkedIn accounts
GET /v1/linkedin/accountsworkspace:readLinkedIn › accounts
GET /v1/linkedin/accounts/:idworkspace:readLinkedIn › accounts (one)
GET /v1/linkedin/actionsleads:readLinkedIn › actions
DELETE /v1/linkedin/actions/:idleads:writeDelete: LinkedIn › actions (one)
PATCH /v1/linkedin/actions/:idleads:writeUpdate: LinkedIn › actions (one)
POST /v1/linkedin/actions/:id/holdleads:writeLinkedIn › actions hold
POST /v1/linkedin/actions/:id/resumeleads:writeLinkedIn › actions resume
GET /v1/linkedin/engagement/statsworkspace:readLinkedIn › engagement stats
GET /v1/linkedin/growthworkspace:readLinkedIn › growth
GET /v1/linkedin/growth/commentsworkspace:readLinkedIn › growth comments
GET /v1/linkedin/growth/postsworkspace:readLinkedIn › growth posts
GET /v1/linkedin/growth/statsworkspace:readLinkedIn › growth stats
GET /v1/linkedin/growth/targetsworkspace:readLinkedIn › growth targets
GET /v1/mailboxesmailboxes:readList mailboxes
GET /v1/mailboxes/:idmailboxes:readGet a mailbox
PATCH /v1/mailboxes/:idmailboxes:writeUpdate a mailbox
POST /v1/mailboxes/:id/pausemailboxes:writeMailbox › pause
GET /v1/mailboxes/:id/placement-testsmailboxes:readMailbox › placement tests
POST /v1/mailboxes/:id/resumemailboxes:writeMailbox › resume
GET /v1/mailboxes/:id/warmupmailboxes:readMailbox › warmup
GET /v1/mailboxes/connect-optionsmailboxes:readMailboxes › connect options
GET /v1/mailboxes/domainsmailboxes:readMailboxes › domains
GET /v1/mailboxes/volume-quotemailboxes:readMailboxes › volume quote
GET /v1/routingworkspace:readList routing
GET /v1/sentinbox:readList sent
GET /v1/sent/:idinbox:readGet a sent email
GET /v1/sent/countsinbox:readSent › counts

Visitors

Companies and people visiting your website (company-by-IP matches are inferred).

EndpointScopeWhat it doesInputReturns
POST /v1/privacy/deletion-requestsvisitors:writePrivacy › deletion requests
GET /v1/visitorsvisitors:readList visitors
DELETE /v1/visitors/:idvisitors:writeDelete a visitor
GET /v1/visitors/:idvisitors:readGet a visitor
POST /v1/visitors/:id/add-to-agentvisitors:write outboundVisitor › add to agent
POST /v1/visitors/deletion-requestsvisitors:writeVisitors › deletion requests
GET /v1/visitors/installvisitors:readVisitors › install
DELETE /v1/visitors/person-vendorvisitors:writeDelete: Visitors › person vendor
GET /v1/visitors/person-vendorvisitors:readVisitors › person vendor
PUT /v1/visitors/person-vendorvisitors:writeUpdate: Visitors › person vendor
GET /v1/visitors/rulesvisitors:readVisitors › rules
POST /v1/visitors/rulesvisitors:write outboundVisitors › rules
DELETE /v1/visitors/rules/:idvisitors:writeDelete: Visitors › rules (one)
PATCH /v1/visitors/rules/:idvisitors:write outboundUpdate: Visitors › rules (one)
GET /v1/visitors/sitesvisitors:readVisitors › sites
POST /v1/visitors/sitesvisitors:writeVisitors › sites
DELETE /v1/visitors/sites/:idvisitors:writeDelete: Visitors › sites (one)
GET /v1/visitors/sites/:idvisitors:readVisitors › sites (one)
PATCH /v1/visitors/sites/:idvisitors:writeUpdate: Visitors › sites (one)
POST /v1/visitors/sites/:id/checkvisitors:writeVisitors › sites check
GET /v1/visitors/sites/:id/noticevisitors:readVisitors › sites notice
POST /v1/visitors/sites/:id/visit-as-mevisitors:writeVisitors › sites visit as me
GET /v1/visitors/sourcesvisitors:readVisitors › sources

Webhooks

Workspace webhook endpoints and their deliveries.

EndpointScopeWhat it doesInputReturns
POST /v1/webhook-deliveries/:id/retrywebhooks:writeRetry a webhook delivery202 the delivery
GET /v1/webhookswebhooks:readList webhook endpoints{ items, events }
POST /v1/webhookswebhooks:writeAdd a webhook endpoint{ url, events: ("lead.ready" | "reply.received" | "visitor.identified")[], description? }201 the endpoint with its secret (shown once)
DELETE /v1/webhooks/:idwebhooks:writeDelete a webhook endpoint{ ok: true, id, deleted: true }
GET /v1/webhooks/:idwebhooks:readGet a webhook endpointthe endpoint with its last 30 days
PATCH /v1/webhooks/:idwebhooks:writeUpdate a webhook endpointany of { url, events, status: "active" | "paused", description }the endpoint
GET /v1/webhooks/:id/deliverieswebhooks:readAn endpoint's deliveries?status=&limit=&cursor={ items, next_cursor }
POST /v1/webhooks/:id/rotate-secretwebhooks:writeRotate an endpoint's signing secret{ id, secret, secret_hint }
POST /v1/webhooks/:id/testwebhooks:writeSend a test event{ event? }202 the queued delivery

Workspace

Your workspace, onboarding, setup, integrations, assistant and background jobs.

EndpointScopeWhat it doesInputReturns
POST /v1/copilot/askcopilot:readCopilot › ask
GET /v1/copilot/ask/:idcopilot:readCopilot › ask (one)
GET /v1/copilot/capabilitiescopilot:readCopilot › capabilities
GET /v1/copilot/threadscopilot:readCopilot › threads
GET /v1/integrationsworkspace:readList integrations
GET /v1/integrations/:id/account-syncworkspace:readAccount signals on CRM company records: the setting, the field map, what this CRM takes, how many were written{ supported, reason, settings: { on, create_companies, fields }, field_keys, field_hint, fields_allowed, fields_reason, locked, locked_reason, counts: { written, not_found, failed, created }, last_synced_at, last_error }
PUT /v1/integrations/:id/account-syncsignals:writeWrite account signals to company records (on or off), create missing companies, and the field map (written by a job){ on?, create_companies?, fields?: { score?, why_now?, newest_at?, signals?, app_url? } (the CRM field names; null clears one) }the view with checking
POST /v1/integrations/:id/account-sync/runsignals:writeWrite account signals now: every account compared again (a job; only changed stories are written)202 the view with checking
PATCH /v1/integrations/:id/exclusionsexclusions:writeUpdate: Integration › exclusions
POST /v1/integrations/:id/exclusions/syncexclusions:writeIntegration › exclusions sync
GET /v1/integrations/:id/mondayworkspace:readIntegration › monday
POST /v1/integrations/:id/monday/syncwatchlist:writeIntegration › monday sync
GET /v1/integrations/:id/pushesleads:readIntegration › pushes
GET /v1/integrations/:id/settingsworkspace:readIntegration › settings
GET /v1/integrations/catalogworkspace:readIntegrations › catalog
POST /v1/integrations/close/importimports:write outboundIntegrations › close import
GET /v1/integrations/close/viewsimports:readIntegrations › close views
POST /v1/integrations/close/views/refreshimports:writeIntegrations › close views refresh
GET /v1/integrations/hubspot/listswatchlist:readIntegrations › HubSpot lists
GET /v1/integrations/hubspot/syncwatchlist:readIntegrations › HubSpot sync
POST /v1/integrations/hubspot/syncwatchlist:writeIntegrations › HubSpot sync
GET /v1/integrations/list-importsimports:readIntegrations › list imports
GET /v1/integrations/monday/importwatchlist:readIntegrations › monday import
GET /v1/integrations/slack/channelsworkspace:readIntegrations › Slack channels
GET /v1/integrations/slack/settingsworkspace:readIntegrations › Slack settings
GET /v1/jobs/:idleads:readProgress of a background job{ id, kind, total, done, status: queued | waiting | running | done | failed | canceled, meta, percent }
GET /v1/onboarding/preview/:idworkspace:readOnboarding › preview (one)
GET /v1/onboarding/profileworkspace:readOnboarding › profile
GET /v1/onboarding/stateworkspace:readOnboarding › state
GET /v1/onboarding/statusworkspace:readOnboarding › status
GET /v1/onboarding/voiceworkspace:readOnboarding › voice
GET /v1/profileworkspace:readList profile
GET /v1/setupworkspace:readList setup
GET /v1/slackworkspace:readList Slack
GET /v1/supplyworkspace:readList supply
POST /v1/support/messagessupport:writeSupport › messages
GET /v1/workspaceworkspace:readYour workspacethe workspace

MCP

The MCP endpoint (JSON-RPC over HTTP). Tools and install steps: /docs/mcp.

EndpointScopeWhat it doesInputReturns
POST /v1/mcpmcp:readMCP endpoint: one JSON-RPC message per request{ jsonrpc: "2.0", id, method, params }the JSON-RPC response

Other

Other endpoints.

EndpointScopeWhat it doesInputReturns
GET /v1/send-windowworkspace:readList send window

Examples

Copy, set KAMATA_API_KEY and run. Ids are placeholders.

POST /v1/data/find-email

Find a verified work email. Emails

curl -s -X POST https://api.kamata.ai/v1/data/find-email \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{"person":{"full_name":"Jane Doe","domain":"acme.example"}}'

POST /v1/data/verify-email

Verify one email as a lookup job. Emails

curl -s -X POST https://api.kamata.ai/v1/data/verify-email \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{"email":"jane.doe@acme.example"}'

POST /v1/verify/email

Verify one email address. Emails

curl -s -X POST https://api.kamata.ai/v1/verify/email \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{"email":"jane.doe@acme.example"}'

POST /v1/verify/emails

Verify up to 5,000 email addresses. Emails

curl -s -X POST https://api.kamata.ai/v1/verify/emails \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{"items":["jane.doe@acme.example","info@acme.example"],"wait_s":5}'

POST /v1/data/find-phone

Find a direct phone. Phones

curl -s -X POST https://api.kamata.ai/v1/data/find-phone \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{"person":{"email":"jane.doe@acme.example"}}'

POST /v1/data/verify-phone

Check a phone line (mobile, landline, VoIP). Phones

curl -s -X POST https://api.kamata.ai/v1/data/verify-phone \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{"phone":"+14155550123"}'

GET /v1/phone/levels

Which lookup levels are available, and their credits. Phones

curl -s "https://api.kamata.ai/v1/phone/levels" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/phone/lookup

Look up one phone number. Phones

curl -s -X POST https://api.kamata.ai/v1/phone/lookup \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{"phone":"+1 415 555 0123","level":"validate"}'

GET /v1/phone/lookup/:id

One phone lookup: status, result and cost. Phones

curl -s "https://api.kamata.ai/v1/phone/lookup/00000000-0000-4000-8000-000000000001" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/phone/lookups

Look up up to 5,000 phone numbers. Phones

curl -s -X POST https://api.kamata.ai/v1/phone/lookups \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{"items":["+1 415 555 0123","415-555-0199"],"default_country":"US"}'

GET /v1/phone/lookups/:id

A phone lookup list: progress and a page of results. Phones

curl -s "https://api.kamata.ai/v1/phone/lookups/00000000-0000-4000-8000-000000000001" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/phone/lookups/:id/export

A phone lookup list as CSV. Phones

curl -s "https://api.kamata.ai/v1/phone/lookups/00000000-0000-4000-8000-000000000001/export" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/phone/reverse

Who is behind one phone number. Phones

curl -s -X POST https://api.kamata.ai/v1/phone/reverse \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

POST /v1/phone/reverses

Who is behind up to 5,000 phone numbers. Phones

curl -s -X POST https://api.kamata.ai/v1/phone/reverses \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

POST /v1/verify/phone

Check one phone number. Phones

curl -s -X POST https://api.kamata.ai/v1/verify/phone \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{"phone":"+1 415 555 0123","checks":["format"]}'

POST /v1/verify/phones

Check up to 5,000 phone numbers. Phones

curl -s -X POST https://api.kamata.ai/v1/verify/phones \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{"items":["+1 415 555 0123","415-555-0199"],"default_country":"US"}'

POST /v1/data/find-contacts

Run find_contacts as a job. People and companies enrichment

curl -s -X POST https://api.kamata.ai/v1/data/find-contacts \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{"args":{"people":[{"full_name":"Jane Doe","domain":"acme.example"}],"want":["email"]}}'

GET /v1/data/find-contacts/:id

A find_contacts job. People and companies enrichment

curl -s "https://api.kamata.ai/v1/data/find-contacts/00000000-0000-4000-8000-000000000001" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/data/match-linkedin

Email to LinkedIn profile. People and companies enrichment

curl -s -X POST https://api.kamata.ai/v1/data/match-linkedin \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{"email":"jane.doe@acme.example"}'

POST /v1/enrich/companies

Enrich up to 5,000 companies. People and companies enrichment

curl -s -X POST https://api.kamata.ai/v1/enrich/companies \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{"items":["acme.example"]}'

POST /v1/enrich/people

Enrich up to 5,000 people. People and companies enrichment

curl -s -X POST https://api.kamata.ai/v1/enrich/people \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{"items":[{"full_name":"Jane Doe","domain":"acme.example"}],"want":["email"]}'

GET /v1/enrich/batches/:id

Same as /v1/verify/batches/:id. Batches and files

curl -s "https://api.kamata.ai/v1/enrich/batches/00000000-0000-4000-8000-000000000001" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/enrich/batches/:id/download-link

Same as /v1/verify/batches/:id/download-link. Batches and files

curl -s -X POST https://api.kamata.ai/v1/enrich/batches/00000000-0000-4000-8000-000000000001/download-link \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/enrich/batches/:id/export

Same as /v1/verify/batches/:id/export. Batches and files

curl -s "https://api.kamata.ai/v1/enrich/batches/00000000-0000-4000-8000-000000000001/export" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/enrich/upload

Enrich a CSV or .xlsx file. Batches and files

curl -s https://api.kamata.ai/v1/enrich/upload \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -F "file=@contacts.csv"

GET /v1/verify/batches/:id

Batch progress and a page of results. Batches and files

curl -s "https://api.kamata.ai/v1/verify/batches/00000000-0000-4000-8000-000000000001" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/verify/batches/:id/download-link

A one-hour download link to the results. Batches and files

curl -s -X POST https://api.kamata.ai/v1/verify/batches/00000000-0000-4000-8000-000000000001/download-link \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/verify/batches/:id/export

Batch results as a file. Batches and files

curl -s "https://api.kamata.ai/v1/verify/batches/00000000-0000-4000-8000-000000000001/export" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/verify/upload

Verify a CSV or .xlsx file (≤ 5,000 rows). Batches and files

curl -s https://api.kamata.ai/v1/verify/upload \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -F "file=@contacts.csv"

GET /v1/data/lookups

Your lookups, newest first. Lookups

curl -s "https://api.kamata.ai/v1/data/lookups" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/data/lookups/:id

One lookup and its result. Lookups

curl -s "https://api.kamata.ai/v1/data/lookups/00000000-0000-4000-8000-000000000001" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/credits

The credit wallet: included, rolled over, bought, used, left. Credits and plan

curl -s "https://api.kamata.ai/v1/credits" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/credits/usage

This month's credits by person, API key and connected app, by action, and per day. Credits and plan

curl -s "https://api.kamata.ai/v1/credits/usage" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/data/credits

Credits left this month and the price per action. Credits and plan

curl -s "https://api.kamata.ai/v1/data/credits" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/plan

Your plan and its limits. Credits and plan

curl -s "https://api.kamata.ai/v1/plan" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/usage

This month's usage against your plan. Credits and plan

curl -s "https://api.kamata.ai/v1/usage" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/companies/:id/competitors

A company's scored competitors with their evidence. Web search, news and competitors

curl -s "https://api.kamata.ai/v1/companies/00000000-0000-4000-8000-000000000001/competitors" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/companies/:id/news

A company's recent news, each item with its link and date. Web search, news and competitors

curl -s "https://api.kamata.ai/v1/companies/00000000-0000-4000-8000-000000000001/news" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/search/web

Search our company web index and news. Web search, news and competitors

curl -s "https://api.kamata.ai/v1/search/web" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/search/web/refresh

Look further for news or competitors (runs as a job). Web search, news and competitors

curl -s -X POST https://api.kamata.ai/v1/search/web/refresh \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{"intent":"news","domain":"acme.example"}'

GET /v1/data/companies/:domain/technographics

Technologies named in a company's job posts (inferred) and, as a separate list, seen on its website. Technologies

curl -s "https://api.kamata.ai/v1/data/companies/00000000-0000-4000-8000-000000000001/technographics" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/data/tech/catalog

The technology catalog: parent categories, categories, every technology and how many sites use it now. Technologies

curl -s "https://api.kamata.ai/v1/data/tech/catalog" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/data/tech/sites

Companies whose websites use a technology (our own crawl: page code, headers, DNS, files). Technologies

curl -s "https://api.kamata.ai/v1/data/tech/sites" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/data/companies/:domain/hiring

What a company is hiring for: open posts, posts in the last 30 days, by function and seniority, its newest posts and the boards we read. Jobs

curl -s "https://api.kamata.ai/v1/data/companies/00000000-0000-4000-8000-000000000001/hiring" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/data/jobs

Job posts from companies' own public job boards and careers pages (our own dataset), newest first. Jobs

curl -s "https://api.kamata.ai/v1/data/jobs" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/data/jobs/:id

One job post with its full description. Jobs

curl -s "https://api.kamata.ai/v1/data/jobs/00000000-0000-4000-8000-000000000001" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/contacts

List your contacts. People and companies search

curl -s "https://api.kamata.ai/v1/contacts" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/contacts/:id

Get a contact. People and companies search

curl -s "https://api.kamata.ai/v1/contacts/00000000-0000-4000-8000-000000000001" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/lookalikes

List lookalike runs. People and companies search

curl -s "https://api.kamata.ai/v1/lookalikes" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/lookalikes

Find companies like your best ones (runs as a job). People and companies search

curl -s -X POST https://api.kamata.ai/v1/lookalikes \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

GET /v1/lookalikes/:id

A lookalike run and its graded companies. People and companies search

curl -s "https://api.kamata.ai/v1/lookalikes/00000000-0000-4000-8000-000000000001" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/search/companies

Search companies. People and companies search

curl -s "https://api.kamata.ai/v1/search/companies" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/search/companies/match

Match a company by name or domain. People and companies search

curl -s "https://api.kamata.ai/v1/search/companies/match" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/search/companies/match

Match a list of companies by name or domain. People and companies search

curl -s -X POST https://api.kamata.ai/v1/search/companies/match \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

GET /v1/search/export

Search results as CSV. People and companies search

curl -s "https://api.kamata.ai/v1/search/export" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/search/find-email

Find the verified email of a search result (runs as a job). People and companies search

curl -s -X POST https://api.kamata.ai/v1/search/find-email \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

POST /v1/search/find-phone

Find the phone of a search result (runs as a job). People and companies search

curl -s -X POST https://api.kamata.ai/v1/search/find-phone \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

GET /v1/search/leads

Find leads: people or companies with recent buying signals. People and companies search

curl -s "https://api.kamata.ai/v1/search/leads" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/search/live

Run a live people or company search (runs as a job). People and companies search

curl -s -X POST https://api.kamata.ai/v1/search/live \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

POST /v1/search/live/preview

Cost preview of a live people or company search (nothing spent). People and companies search

curl -s -X POST https://api.kamata.ai/v1/search/live/preview \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

POST /v1/search/market

Search the market database (cost preview, then confirm). People and companies search

curl -s -X POST https://api.kamata.ai/v1/search/market \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

POST /v1/search/market/preview

Cost preview of a market database search (nothing spent). People and companies search

curl -s -X POST https://api.kamata.ai/v1/search/market/preview \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

GET /v1/search/people

Search people. People and companies search

curl -s "https://api.kamata.ai/v1/search/people" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/search/reveal

Reveal emails or mobiles for search results (cost preview first). People and companies search

curl -s -X POST https://api.kamata.ai/v1/search/reveal \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

GET /v1/search/saved

List saved searches. People and companies search

curl -s "https://api.kamata.ai/v1/search/saved" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/search/saved

Save a search. People and companies search

curl -s -X POST https://api.kamata.ai/v1/search/saved \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

POST /v1/search/verify-email

Verify one email from search (runs as a job). People and companies search

curl -s -X POST https://api.kamata.ai/v1/search/verify-email \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

GET /v1/account-lists

List your account lists, each with its signals and its progress. Signals

curl -s "https://api.kamata.ai/v1/account-lists" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/account-lists

Make an account list. Signals

curl -s -X POST https://api.kamata.ai/v1/account-lists \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

DELETE /v1/account-lists/:id

Delete an account list (never "My accounts"); its accounts stay on "My accounts". Signals

curl -s -X DELETE https://api.kamata.ai/v1/account-lists/00000000-0000-4000-8000-000000000001 \
  -H "Authorization: Bearer $KAMATA_API_KEY"

PATCH /v1/account-lists/:id

Rename an account list (never "My accounts"). Signals

curl -s -X PATCH https://api.kamata.ai/v1/account-lists/00000000-0000-4000-8000-000000000001 \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

POST /v1/account-lists/:id/members

Add accounts to a list by domain: a paste or a file (checked against its signals as a job). Also needs watchlist:write. Signals

curl -s -X POST https://api.kamata.ai/v1/account-lists/00000000-0000-4000-8000-000000000001/members \
  -H "Authorization: Bearer $KAMATA_API_KEY"

PUT /v1/account-lists/:id/signal-set

Pick the signal set a list takes its signals from, or null for its own. Signals

curl -s -X PUT https://api.kamata.ai/v1/account-lists/00000000-0000-4000-8000-000000000001/signal-set \
  -H "Authorization: Bearer $KAMATA_API_KEY"

PUT /v1/account-lists/:id/signals

Set the signals a list is checked against (the whole set). Signals

curl -s -X PUT https://api.kamata.ai/v1/account-lists/00000000-0000-4000-8000-000000000001/signals \
  -H "Authorization: Bearer $KAMATA_API_KEY"

PUT /v1/account-lists/:id/suggestions

Keep finding accounts for a list (on or off) and what a suggestion must fit. Signals

curl -s -X PUT https://api.kamata.ai/v1/account-lists/00000000-0000-4000-8000-000000000001/suggestions \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/account-lists/:id/suggestions/watch

Watch several suggested accounts at once (refused whole past the plan). Also needs watchlist:write. Signals

curl -s -X POST https://api.kamata.ai/v1/account-lists/00000000-0000-4000-8000-000000000001/suggestions/watch \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

GET /v1/accounts

List accounts: score with its parts, Why now, signals true, newest evidence, owner and list. Signals

curl -s "https://api.kamata.ai/v1/accounts" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

DELETE /v1/accounts/:id

Take an account off its list; off "My accounts" it leaves every list and the watchlist. Also needs watchlist:write. Signals

curl -s -X DELETE https://api.kamata.ai/v1/accounts/00000000-0000-4000-8000-000000000001 \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/accounts/:id

One account: its score and Why now, a line per signal with its evidence link and date or the reason it has none, and what we read. Signals

curl -s "https://api.kamata.ai/v1/accounts/00000000-0000-4000-8000-000000000001" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

PATCH /v1/accounts/:id

Correct an account's domain. Also needs watchlist:write. Signals

curl -s -X PATCH https://api.kamata.ai/v1/accounts/00000000-0000-4000-8000-000000000001 \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

POST /v1/accounts/:id/answers/:customSignalId/feedback

"Not right?": rate the answer one signal gave for this account (good, bad, or null to clear). Signals

curl -s -X POST https://api.kamata.ai/v1/accounts/00000000-0000-4000-8000-000000000001/answers/00000000-0000-4000-8000-000000000001/feedback \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/accounts/:id/lead

Make a lead from an account (queued as a job; every lead check applies). Signals

curl -s -X POST https://api.kamata.ai/v1/accounts/00000000-0000-4000-8000-000000000001/lead \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/accounts/:id/reject

Reject a suggested account: never suggested again; names the filter that fixes the reason. Signals

curl -s -X POST https://api.kamata.ai/v1/accounts/00000000-0000-4000-8000-000000000001/reject \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/accounts/:id/watch

Watch a suggested account: it joins its list and the watchlist and is checked against the list's signals. Also needs watchlist:write. Signals

curl -s -X POST https://api.kamata.ai/v1/accounts/00000000-0000-4000-8000-000000000001/watch \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/accounts/outcomes

Your won and lost deals on file (add them with POST /v1/imports kind "outcomes"). Signals

curl -s "https://api.kamata.ai/v1/accounts/outcomes" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/accounts/outcomes

Add won and lost deals one by one (then "My accounts" is tested again). Signals

curl -s -X POST https://api.kamata.ai/v1/accounts/outcomes \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

GET /v1/accounts/overview

One of your accounts by its domain: score, Why now with quotes, a line per signal, what we read. Signals

curl -s "https://api.kamata.ai/v1/accounts/overview" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/accounts/priorities

Today's top accounts: the Accounts screen's order, only those with a score, each Why now fact with its date, link and quote. Signals

curl -s "https://api.kamata.ai/v1/accounts/priorities" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/custom-signals

List custom signals. Signals

curl -s "https://api.kamata.ai/v1/custom-signals" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/custom-signals

Describe a custom signal in one sentence (built as a job). Signals

curl -s -X POST https://api.kamata.ai/v1/custom-signals \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

GET /v1/custom-signals/:id

A custom signal, its latest hits and runs. Signals

curl -s "https://api.kamata.ai/v1/custom-signals/00000000-0000-4000-8000-000000000001" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

PUT /v1/custom-signals/:id/alerts

Set where a signal sends its matches, or mute it. Signals

curl -s -X PUT https://api.kamata.ai/v1/custom-signals/00000000-0000-4000-8000-000000000001/alerts \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/custom-signals/:id/backtest/deals

The won or lost deals a signal came before, each with its dated proof. Signals

curl -s "https://api.kamata.ai/v1/custom-signals/00000000-0000-4000-8000-000000000001/backtest/deals" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/custom-signals/:id/outcomes

One signal's results and suggested priority. Signals

curl -s "https://api.kamata.ai/v1/custom-signals/00000000-0000-4000-8000-000000000001/outcomes" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/custom-signals/backtest

What predicts wins: per signal, the won and lost deals it came before and its matches in 12 months. Signals

curl -s "https://api.kamata.ai/v1/custom-signals/backtest" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/custom-signals/backtest

Test signals on the last 12 months of a list's accounts (runs as a job). Signals

curl -s -X POST https://api.kamata.ai/v1/custom-signals/backtest \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

GET /v1/custom-signals/outcomes

Signal results: per signal the leads, sends, positive replies, meetings and wins in the latest window, and a suggested priority. Signals

curl -s "https://api.kamata.ai/v1/custom-signals/outcomes" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/custom-signals/tryouts

Try up to five sentences before anything is saved (read and counted as a job). Signals

curl -s -X POST https://api.kamata.ai/v1/custom-signals/tryouts \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

GET /v1/custom-signals/tryouts/:id

A tried sentence: how it was read, its 30-day count and example companies. Signals

curl -s "https://api.kamata.ai/v1/custom-signals/tryouts/00000000-0000-4000-8000-000000000001" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/custom-signals/tryouts/:id/backtest

A tried sentence's history test: matches in 12 months and the wins it came before. Signals

curl -s "https://api.kamata.ai/v1/custom-signals/tryouts/00000000-0000-4000-8000-000000000001/backtest" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/custom-signals/tryouts/:id/backtest

Test a tried sentence on the last 12 months (runs as a job). Signals

curl -s -X POST https://api.kamata.ai/v1/custom-signals/tryouts/00000000-0000-4000-8000-000000000001/backtest \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/custom-signals/tryouts/:id/backtest/deals

The won or lost deals a tried sentence came before, each with its dated proof. Signals

curl -s "https://api.kamata.ai/v1/custom-signals/tryouts/00000000-0000-4000-8000-000000000001/backtest/deals" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/custom-signals/tryouts/:id/keep

Turn a tried sentence on as a signal. Signals

curl -s -X POST https://api.kamata.ai/v1/custom-signals/tryouts/00000000-0000-4000-8000-000000000001/keep \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/events

List product events. Signals

curl -s "https://api.kamata.ai/v1/events" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/events

Send product events (one or up to 500). Signals

curl -s -X POST https://api.kamata.ai/v1/events \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

GET /v1/events/summary

Product events in the last 30 days. Signals

curl -s "https://api.kamata.ai/v1/events/summary" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/signal-alerts

List signal alerts with where each went. Signals

curl -s "https://api.kamata.ai/v1/signal-alerts" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/signal-alerts/retry

Send failed signal alerts again (sent by a job). Signals

curl -s -X POST https://api.kamata.ai/v1/signal-alerts/retry \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

GET /v1/signal-alerts/status

Which alert channels are on the plan, connected or failing. Signals

curl -s "https://api.kamata.ai/v1/signal-alerts/status" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/signal-library/outcomes

The network's suggested priority per library signal (only while network learning is on). Signals

curl -s "https://api.kamata.ai/v1/signal-library/outcomes" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/signal-sets

List your signal sets, each with its signals and the lists that use it. Signals

curl -s "https://api.kamata.ai/v1/signal-sets" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/signal-sets

Make a signal set. Signals

curl -s -X POST https://api.kamata.ai/v1/signal-sets \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

DELETE /v1/signal-sets/:id

Delete a signal set; its lists keep the signals they have. Signals

curl -s -X DELETE https://api.kamata.ai/v1/signal-sets/00000000-0000-4000-8000-000000000001 \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/signal-sets/:id

One signal set: its signals with the set's priority and the lists that use it. Signals

curl -s "https://api.kamata.ai/v1/signal-sets/00000000-0000-4000-8000-000000000001" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

PATCH /v1/signal-sets/:id

Rename a signal set or replace its signals; every list on it follows (new signals are checked as a job). Signals

curl -s -X PATCH https://api.kamata.ai/v1/signal-sets/00000000-0000-4000-8000-000000000001 \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

GET /v1/signals

Buying signals behind your leads. Signals

curl -s "https://api.kamata.ai/v1/signals" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/signals/:id

Get a signal with its evidence link and date. Signals

curl -s "https://api.kamata.ai/v1/signals/00000000-0000-4000-8000-000000000001" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/export/leads.csv

Leads as CSV. Leads

curl -s "https://api.kamata.ai/v1/export/leads.csv" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/leads

List leads. Leads

curl -s "https://api.kamata.ai/v1/leads" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/leads/:id

Get a lead: company, person, evidence, fit and draft. Leads

curl -s "https://api.kamata.ai/v1/leads/00000000-0000-4000-8000-000000000001" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/leads/:id/approve

Approve a lead for sending. Leads

curl -s -X POST https://api.kamata.ai/v1/leads/00000000-0000-4000-8000-000000000001/approve \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/leads/:id/drafts

Save an edited draft. Leads

curl -s -X POST https://api.kamata.ai/v1/leads/00000000-0000-4000-8000-000000000001/drafts \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/leads/:id/reject

Reject a lead. Leads

curl -s -X POST https://api.kamata.ai/v1/leads/00000000-0000-4000-8000-000000000001/reject \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/leads/bulk-approve

Approve many leads at once. Leads

curl -s -X POST https://api.kamata.ai/v1/leads/bulk-approve \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

GET /v1/queued

Queued first emails: scheduled, not scheduled yet, on hold. Leads

curl -s "https://api.kamata.ai/v1/queued" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/queued/bulk

Hold, resume or send back to review. Leads

curl -s -X POST https://api.kamata.ai/v1/queued/bulk \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

GET /v1/stats/today

Today's numbers. Leads

curl -s "https://api.kamata.ai/v1/stats/today" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/tags

List tags. Leads

curl -s "https://api.kamata.ai/v1/tags" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/tags

Create a tag. Leads

curl -s -X POST https://api.kamata.ai/v1/tags \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

GET /v1/exclusions

List exclusions. Lists

curl -s "https://api.kamata.ai/v1/exclusions" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/exclusions

Exclude domains or emails (never contacted). Lists

curl -s -X POST https://api.kamata.ai/v1/exclusions \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{"domains":["acme.example"],"reason":"customer"}'

GET /v1/exclusions/export

Exclusions as CSV. Lists

curl -s "https://api.kamata.ai/v1/exclusions/export" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/imports

List imports. Lists

curl -s "https://api.kamata.ai/v1/imports" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/imports

Import a list (CSV upload or rows). Lists

curl -s https://api.kamata.ai/v1/imports \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -F "kind=watchlist" -F "file=@companies.csv"

GET /v1/imports/:id

Get an import and its summary. Lists

curl -s "https://api.kamata.ai/v1/imports/00000000-0000-4000-8000-000000000001" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/imports/:id/enrich

Enrich an import's rows (estimate first with dry_run). Lists

curl -s -X POST https://api.kamata.ai/v1/imports/00000000-0000-4000-8000-000000000001/enrich \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/imports/:id/rows

An import's rows. Lists

curl -s "https://api.kamata.ai/v1/imports/00000000-0000-4000-8000-000000000001/rows" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/watchlist

List watched companies. Lists

curl -s "https://api.kamata.ai/v1/watchlist" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/watchlist

Watch companies by domain. Lists

curl -s -X POST https://api.kamata.ai/v1/watchlist \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{"domains":["acme.example"],"agent_id":null}'

DELETE /v1/watchlist/:id

Stop watching a company. Lists

curl -s -X DELETE https://api.kamata.ai/v1/watchlist/00000000-0000-4000-8000-000000000001 \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/agents

List agents. Agents

curl -s "https://api.kamata.ai/v1/agents" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/agents

Create an agent from a domain or one sentence. Agents

curl -s -X POST https://api.kamata.ai/v1/agents \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

DELETE /v1/agents/:id

Delete an agent. Agents

curl -s -X DELETE https://api.kamata.ai/v1/agents/00000000-0000-4000-8000-000000000001 \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/agents/:id

Get an agent. Agents

curl -s "https://api.kamata.ai/v1/agents/00000000-0000-4000-8000-000000000001" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

PATCH /v1/agents/:id

Update an agent. Agents

curl -s -X PATCH https://api.kamata.ai/v1/agents/00000000-0000-4000-8000-000000000001 \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

GET /v1/inbox

List replies. Inbox and sending

curl -s "https://api.kamata.ai/v1/inbox" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/webhook-deliveries/:id/retry

Retry a webhook delivery. Webhooks

curl -s -X POST https://api.kamata.ai/v1/webhook-deliveries/00000000-0000-4000-8000-000000000001/retry \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/webhooks

List webhook endpoints. Webhooks

curl -s "https://api.kamata.ai/v1/webhooks" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/webhooks

Add a webhook endpoint. Webhooks

curl -s -X POST https://api.kamata.ai/v1/webhooks \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{"url":"https://hooks.acme.example/leads","events":["lead.ready"]}'

DELETE /v1/webhooks/:id

Delete a webhook endpoint. Webhooks

curl -s -X DELETE https://api.kamata.ai/v1/webhooks/00000000-0000-4000-8000-000000000001 \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/webhooks/:id

Get a webhook endpoint. Webhooks

curl -s "https://api.kamata.ai/v1/webhooks/00000000-0000-4000-8000-000000000001" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

PATCH /v1/webhooks/:id

Update a webhook endpoint. Webhooks

curl -s -X PATCH https://api.kamata.ai/v1/webhooks/00000000-0000-4000-8000-000000000001 \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

GET /v1/webhooks/:id/deliveries

An endpoint's deliveries. Webhooks

curl -s "https://api.kamata.ai/v1/webhooks/00000000-0000-4000-8000-000000000001/deliveries" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/webhooks/:id/rotate-secret

Rotate an endpoint's signing secret. Webhooks

curl -s -X POST https://api.kamata.ai/v1/webhooks/00000000-0000-4000-8000-000000000001/rotate-secret \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/webhooks/:id/test

Send a test event. Webhooks

curl -s -X POST https://api.kamata.ai/v1/webhooks/00000000-0000-4000-8000-000000000001/test \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/integrations/:id/account-sync

Account signals on CRM company records: the setting, the field map, what this CRM takes, how many were written. Workspace

curl -s "https://api.kamata.ai/v1/integrations/00000000-0000-4000-8000-000000000001/account-sync" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

PUT /v1/integrations/:id/account-sync

Write account signals to company records (on or off), create missing companies, and the field map (written by a job). Workspace

curl -s -X PUT https://api.kamata.ai/v1/integrations/00000000-0000-4000-8000-000000000001/account-sync \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/integrations/:id/account-sync/run

Write account signals now: every account compared again (a job; only changed stories are written). Workspace

curl -s -X POST https://api.kamata.ai/v1/integrations/00000000-0000-4000-8000-000000000001/account-sync/run \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{}'

GET /v1/jobs/:id

Progress of a background job. Workspace

curl -s "https://api.kamata.ai/v1/jobs/00000000-0000-4000-8000-000000000001" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

GET /v1/workspace

Your workspace. Workspace

curl -s "https://api.kamata.ai/v1/workspace" \
  -H "Authorization: Bearer $KAMATA_API_KEY"

POST /v1/mcp

MCP endpoint: one JSON-RPC message per request. MCP

curl -s -X POST https://api.kamata.ai/v1/mcp \
  -H "Authorization: Bearer $KAMATA_API_KEY" \
  -H "content-type: application/json" \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/list","params":{}}'

Results

Email

{ email, status: valid | invalid | catch_all | unknown | disposable | role, reason, mx, source, checked_at, do_not_contact, sendable, grade, grade_reasons, from_cache, credits_charged }. sendable is true only for valid addresses not on the opt-out list or your exclusions. A hard bounce or a departure on record grades an address F even when sendable is true: send only to grades A and B. A verification is a measurement.

Phone

{ e164, valid, possible, country, line_type: mobile | landline | voip | toll_free | unknown, line_type_inferred, carrier, source, checked_at, reason }. Without checks: ["line_type"] the line type comes from the numbering plan and is inferred (line_type_inferred: true); with it, a carrier line check measures it.

Person (enrich)

{ status: found | partial | not_found | invalid_input, name, company, domain, email, email_status, email_verified, phone, phone_inferred, linkedin_url, linkedin_inferred, title, location, … }, each value with its source. An email is returned only when the verifier said valid; nothing is pattern-guessed. Phones and matched LinkedIn profiles are provider matches (inferred).

Company (enrich)

{ status, name, domain, domain_inferred, attributes: { industry, employee_count, employee_range, founded_year, revenue_band, funding_stage, country, address, linkedin_url, location }, missing, reason }. Each attribute carries its source and date; a vendor's modelled value is inferred: true; a missing field is listed in missing, never 0.

Lookups (/v1/data/*)

GET /v1/data/lookups/:id → result: verify { email, email_status, sendable, verified: { measured: true, source, checked_at }, reason }; find / match { found, email | phone | linkedin_url, match: { inferred: true, source, matched_at }, cached, reason }; phone check { found, phone, line_type, valid, carrier, checked_at, cached, reason }.

Risk grades (A–F)

Every email result read from /v1/verify/* carries grade and grade_reasons (the MCP tools show the grade with one short reason). This table is computed by the same function that grades results:

GradeWhenReasons returnedSendable
Avalid, with replies on recorddeliverable; replies on recordyes
Avalid, delivered to at least twice without a bouncedeliverable; delivered before without a bounceyes
Bvaliddeliverableyes
Ccatch_allcatch-all domain: accepts every address, so this one cannot be confirmedno
Drole (info@, sales@ …)shared role inbox, not a personno
Dunknownthe verifier could not decideno
Finvalidundeliverableno
Fdisposablethrowaway inbox domainno
Fa hard bounce on recordhard bounce on recordno
Fthe person left the companyaccepts mail, person goneno
Fopted outopted outno
Bon your exclusion listdeliverableyes

Batches and pagination

Every verify and enrich call creates a batch: { batch_id, kind, status: mapping | running | done, is_sample, progress: { done, total, percent, eta_s, eta_reason, rate_per_s }, counts, credits, webhook, upload, error, results, page: { cursor, limit, returned, next_cursor }, pending }.

Webhooks for batch completion

Pass webhook_url (https) when you create a batch. The create call returns webhook_secret once: store it. When the batch is done you get one POST:

{
  "event": "verify.batch.completed",
  "created_at": "2026-01-15T10:00:30.000Z",
  "data": {
    "batch_id": "…",
    "status": "done",
    "counts": "…",
    "results": [
      "… the first page …"
    ],
    "page": {
      "next_cursor": "…"
    }
  }
}

Checking the signature (Node):

const crypto = require('node:crypto');
// header: x-webhook-signature: t=<unix seconds>,v1=<hex>
function verified(rawBody, header, secret) {
  const parts = Object.fromEntries(header.split(',').map((p) => p.split('=')));
  if (Math.abs(Date.now() / 1000 - Number(parts.t)) > 300) return false; // 5-minute tolerance
  const want = crypto.createHmac('sha256', secret).update(`${parts.t}.${rawBody}`).digest('hex');
  const got = Buffer.from(parts.v1 ?? '');
  return got.length === want.length && crypto.timingSafeEqual(Buffer.from(want), got);
}

Workspace-wide webhooks (GET/POST /v1/webhooks, scopes webhooks:read / webhooks:write) are signed the same way.

Rate limits

LimitValue
Per API keyThe key's own per-minute limit, set when it is created (default 6,000 a minute, up to 6,000), never above your plan's ceiling. Over it: 429 with retry-after
Items per batch5,000 (files: 5,000 rows, 200 columns, 20 MB)
Open batches5 running per workspace; more answers 429 too_many_batches
Waiting in the requestwait_s up to 25 seconds

Errors

Errors are JSON: { error, message, issues? }. message is one plain line you can show.

StatusMeaning
400Bad input (issues lists each field)
401Missing, unknown or revoked key
402credits_exhausted (no credits left and no pack could be bought; the body says why and when they reset) or plan_limit
403The key lacks the scope
404Not found, or another workspace's id
409Wrong state: the workspace needs a step first; the message says what to do
429Rate limited or too_many_batches: wait retry-after seconds

Credits

ActionCreditsCharged
Verify an email1per check
Find a work email1only when a verified email is found
Find a phone number12only when a phone is found
Match an email to a LinkedIn profile20only when a profile is found
Check a phone number (mobile, landline or VoIP)1per check (a number checked in the last 90 days is free)
Enrich a company (industry, headcount, revenue, funding, location)2only when a new company detail is found
List a company using a technology1per company returned (a page with no companies is free)
List a job post1per job post returned (a page with none is free)
A company's hiring or job-post technologies1per company with data returned (none on record is free)
Watched-company signal delivered5per signal credit a delivered signal uses (none while monitors find nothing)
Check where a past champion works now5per check (each champion at most once a month)
Look up a phone number (valid, mobile / landline / VoIP, carrier, ported)1per number looked up (the same number again within 90 days is free)
Look up a phone number with its listed caller name2per number looked up, name or not (the same number again within 90 days is free)
Look up a phone number with its name and business / person6per number looked up, name or not (the same number again within 90 days is free)
Look up who a phone number belongs to (caller identity)12per number looked up, match or not (the same number again within 90 days is free)

A repeat of the same lookup within 7 days is free; a find that finds nothing releases its credits. Sample inputs (*.example, linkedin.example, 555-01xx numbers) are free, never counted, and marked is_sample: true.