CompanyList

List company-list sources

Changed on

Requires one of the following scopes: supersearch_enrichments:read, supersearch_enrichments:all, all:read, all:all

get/api/v2/supersearch-enrichment/company-lists/sources

Request

  • Base URL
    https://api.instantly.ai
  • URL
    https://api.instantly.ai/api/v2/supersearch-enrichment/company-lists/sources
  • Auth
    HTTP bearer

Response

Default Response

provider_idstring required
provider_namestring required
logo_idstring required
company_source_idstring required
source_namestring required
credential_sourcesstring[] required
credit_cost_per_saved_recordinteger required
max_records_per_buildinteger required
supports_previewboolean required
connectedboolean
require_any_ofstring[]

Example response

[
  {
    "provider_id": "store_leads",
    "provider_name": "Store Leads",
    "logo_id": "store_leads",
    "company_source_id": "search_companies",
    "source_name": "Search Companies",
    "credit_cost_per_saved_record": 4,
    "max_records_per_build": 2500,
    "supports_preview": true,
    "connected": true,
    "filters": [
      {
        "key": "platform",
        "label": "Platform",
        "description_key": "field_desc_store_leads_technology",
        "options_source": {
          "catalog_id": "theirstack_industries"
        }
      }
    ],
    "require_any_of": [
      "platform",
      "location",
      "category"
    ],
    "recipes": [
      {
        "recipe_id": "ecommerce",
        "title": "Find e-commerce companies",
        "description": "Search companies by criteria."
      }
    ]
  }
]

Changes