Skip to main content
GET
Get enrichment for resource

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

resource_id
string<uuid>
required

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

Example:

"123e4567-e89b-12d3-a456-426614174000"

Response

Default Response

resource_id
string<uuid>
required

ID of the resource being enriched

Example:

"01234567-89ab-cdef-0123-456789abcdef"

enrichment_payload
object
required

Enrichment types

in_progress
boolean

Whether the enrichment is in progress

Example:

false

has_no_leads
boolean

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

Example:

false

exists
boolean

Whether the enrichment exists

Example:

true

auto_update
boolean

Whether leads added to the list will be automatically enriched

Example:

false

is_evergreen
boolean

Whether the enrichment is evergreen

Example:

false

search_filters
object

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