Documentation

/api/prospectfinder routes

77 routes under /api/prospectfinder that an account can call. Columns are explained on the HTTP routes page; type a path, a scope or a tool name to filter.

/api/prospectfinder (77)

MethodsPathScope402ReceiptAccessTools
GET POST/api/prospectfinder/campaignsprospect-pipeline:read prospect-pipeline:write402receiptkeyprospect_campaign_create prospect_campaign_list
GET PATCH/api/prospectfinder/campaigns/[id]prospect-pipeline:read prospect-pipeline:writekeyprospect_campaign_get prospect_campaign_update
GET POST/api/prospectfinder/campaigns/[id]/agency-clients/bulknonesession only
GET/api/prospectfinder/campaigns/[id]/available-fieldsnonesession only
GET PATCH DELETE/api/prospectfinder/campaigns/[id]/backlinksnonesession only
POST/api/prospectfinder/campaigns/[id]/backlinks/apply-filtersnonesession only
GET/api/prospectfinder/campaigns/[id]/backlinks/fetch-status/[applicationId]nonesession only
POST/api/prospectfinder/campaigns/[id]/backlinks/push-to-bulk-analysisnonesession only
GET/api/prospectfinder/campaigns/[id]/backlinks/qualification-historynonesession only
GET/api/prospectfinder/campaigns/[id]/backlinks/qualification-statsnonesession only
GET/api/prospectfinder/campaigns/[id]/backlinks/qualification-status/[applicationId]nonesession only
GET/api/prospectfinder/campaigns/[id]/botdog-export-historynonesession only
GET/api/prospectfinder/campaigns/[id]/botdog-statsnonesession only
GET POST/api/prospectfinder/campaigns/[id]/campaign-typescampaign:read campaign:writekeycampaign_domain_list_rejected campaign_type_assign campaign_type_list campaign_type_rankings_get
PATCH/api/prospectfinder/campaigns/[id]/campaign-types/[typeId]nonesession only
GET POST/api/prospectfinder/campaigns/[id]/citation-checknonesession only
GET POST DELETE/api/prospectfinder/campaigns/[id]/classifycampaign:read campaign:write402receiptkeycampaign_classify_get campaign_classify_reset campaign_classify_start
GET/api/prospectfinder/campaigns/[id]/classify/active-runcampaign:readkeycampaign_classify_status
GET POST PATCH DELETE/api/prospectfinder/campaigns/[id]/competitorsnonesession only
GET POST/api/prospectfinder/campaigns/[id]/composenonesession only
GET POST DELETE/api/prospectfinder/campaigns/[id]/contactscampaign:writekeycampaign_contacts_delete campaign_contacts_discover
GET/api/prospectfinder/campaigns/[id]/domain-enrichmentnonesession only
GET POST/api/prospectfinder/campaigns/[id]/enhancementscampaign:read campaign:write402receiptkeycampaign_enhancements_list campaign_enhancements_override campaign_enhancements_preflight campaign_enhancements_run
POST/api/prospectfinder/campaigns/[id]/enhancements/configcampaign:writekeycampaign_enhancements_config_update
GET PATCH/api/prospectfinder/campaigns/[id]/enhancements/rejectionscampaign:read campaign:writekeycampaign_enhancements_rejections_clear campaign_enhancements_rejections_list
POST/api/prospectfinder/campaigns/[id]/enhancements/rerun-assignmentscampaign:writekeycampaign_enhancements_rerun_assignments
POST/api/prospectfinder/campaigns/[id]/export-csvnonesession only
GET/api/prospectfinder/campaigns/[id]/export-historynonesession only
GET/api/prospectfinder/campaigns/[id]/export/classificationcampaign:readkeycampaign_export_classification
GET/api/prospectfinder/campaigns/[id]/export/outreach-draftscampaign:readkeycampaign_export_outreach_drafts
GET/api/prospectfinder/campaigns/[id]/export/outreach-templatecampaign:readkeycampaign_export_outreach_template
GET/api/prospectfinder/campaigns/[id]/export/rejected-domainscampaign:readkeycampaign_export_rejected_domains
GET/api/prospectfinder/campaigns/[id]/export/serp-resultscampaign:readkeycampaign_export_serp_results
GET/api/prospectfinder/campaigns/[id]/export/type-matchescampaign:readkeycampaign_export_type_matches
POST/api/prospectfinder/campaigns/[id]/import-apollo-csvcampaign:writekeycampaign_contacts_import_csv
POST/api/prospectfinder/campaigns/[id]/import-backlink-domainsnonesession only
POST/api/prospectfinder/campaigns/[id]/import-domainscampaign:writekeyprospect_domains_import
GET POST/api/prospectfinder/campaigns/[id]/inventory-matchescampaign:read prospect-pipeline:writekeycampaign_inventory_list prospect_inventory_crossref
GET/api/prospectfinder/campaigns/[id]/keyword-historynonesession only
GET/api/prospectfinder/campaigns/[id]/keyword-pool/active-runnonesession only
POST/api/prospectfinder/campaigns/[id]/keyword-pool/pullnonesession only
GET/api/prospectfinder/campaigns/[id]/keyword-pool/recent-runsnonesession only
GET/api/prospectfinder/campaigns/[id]/keyword-pool/rowsnonesession only
GET/api/prospectfinder/campaigns/[id]/keyword-pool/summarynonesession only
GET POST/api/prospectfinder/campaigns/[id]/keyword-searchcampaign:read campaign:writekeycampaign_serp_search_create campaign_serp_search_list
GET PATCH DELETE/api/prospectfinder/campaigns/[id]/keyword-search/[searchId]campaign:readkeycampaign_serp_search_status
POST/api/prospectfinder/campaigns/[id]/keyword-search/[searchId]/runcampaign:write402receiptkeycampaign_serp_search_run
GET/api/prospectfinder/campaigns/[id]/keyword-search/aggregatedcampaign:readkeycampaign_serp_aggregated
GET/api/prospectfinder/campaigns/[id]/keyword-seedsnonesession only
PATCH/api/prospectfinder/campaigns/[id]/keyword-seeds/[seedId]nonesession only
GET/api/prospectfinder/campaigns/[id]/metrics/active-runnonesession only
GET POST/api/prospectfinder/campaigns/[id]/metrics/presetsnonesession only
GET POST PUT/api/prospectfinder/campaigns/[id]/metrics/recipesnonesession only
GET/api/prospectfinder/campaigns/[id]/outreach/draftsnonesession only
GET PATCH/api/prospectfinder/campaigns/[id]/outreach/drafts/[draftId]nonesession only
POST/api/prospectfinder/campaigns/[id]/outreach/drafts/[draftId]/re-polishnone402session only
PATCH/api/prospectfinder/campaigns/[id]/outreach/drafts/bulknonesession only
PATCH/api/prospectfinder/campaigns/[id]/outreach/drafts/bulk-replacenonesession only
GET/api/prospectfinder/campaigns/[id]/outreach/eligible-contactsnonesession only
POST/api/prospectfinder/campaigns/[id]/outreach/generate-draftsnone402session only
GET/api/prospectfinder/campaigns/[id]/outreach/polish-statusnonesession only
GET/api/prospectfinder/campaigns/[id]/outreach/roundsnonesession only
GET/api/prospectfinder/campaigns/[id]/outreach/rounds/[roundId]/launch-statusnonesession only
POST/api/prospectfinder/campaigns/[id]/outreach/rounds/[roundId]/polishnone402session only
GET/api/prospectfinder/campaigns/[id]/outreach/rounds/activenonesession only
GET PATCH/api/prospectfinder/campaigns/[id]/prospect-domainsnonesession only
POST/api/prospectfinder/campaigns/[id]/push-to-botdognonesession only
POST/api/prospectfinder/campaigns/[id]/push-to-botdog-batchnonesession only
POST/api/prospectfinder/campaigns/[id]/push-to-botdog-streamnonesession only
POST/api/prospectfinder/campaigns/[id]/push-to-manyreachnonesession only
GET POST DELETE/api/prospectfinder/campaigns/[id]/qualify-domainsnonesession only
POST/api/prospectfinder/campaigns/[id]/rerun-qualificationnonesession only
POST/api/prospectfinder/campaigns/[id]/verify-contactscampaign:write402receiptkeycampaign_contacts_verify
GET/api/prospectfinder/campaigns/[id]/verify-contacts/estimatecampaign:readkeycampaign_contacts_verify_estimate
GET/api/prospectfinder/campaigns/[id]/workflow-resultscampaign:readkeycampaign_discovery_results
GET/api/prospectfinder/estimate-costprospect-pipeline:readkey
POST/api/prospectfinder/keyword-search/check-duplicatesnonesession only