v1

latestOpenAPI 3.1.02026-07-2617125852.3 KB
SuperSearchEnrichment

Get enrichment for resource

Get the enrichment for a specific resource

get/api/v2/supersearch-enrichment/{resource_id}

Path parameters

resource_idstring uuid required
Example:123e4567-e89b-12d3-a456-426614174000

The ID of the list or campaign to retrieve the enrichment.

Response

Default Response

resource_idstring uuid required

ID of the resource being enriched

in_progressboolean

Whether the enrichment is in progress

has_no_leadsboolean

Whether the enrichment for this resource returned no leads for these search filters. This is only applicable for enrichments created from SuperSearch.

existsboolean

Whether the enrichment exists

auto_updateboolean

Whether leads added to the list will be automatically enriched

is_evergreenboolean

Whether the enrichment is evergreen

search_filtersobject

Search filters used to create this enrichment (only present for enrichments created from SuperSearch)

Example response

{
  "resource_id": "01234567-89ab-cdef-0123-456789abcdef",
  "exists": true,
  "enrichment_payload": {
    "work_email_enrichment": true,
    "fully_enriched_profile": true,
    "joblisting": true,
    "technologies": true,
    "news": true,
    "funding": true,
    "engagement_score": true,
    "custom_flow": [
      "leadmagic",
      "prospeo",
      "hunter"
    ],
    "limit": 10,
    "autofill": true
  }
}