Skip to main content
This schema describes objects returned by the SuperSearch Enrichment endpoints.

An enrichment can take different forms, such as email enrichment or LinkedIn enrichment. Leads may be imported from SuperSearch using the dedicated endpoint, or enriched directly within a list or campaign by attaching an enrichment to it.

​
id
string
required
read-only

Unique identifier for the enrichment

Example:

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

​
organization_id
string<uuid>
required
read-only

Organization ID that created this enrichment

Example:

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

​
resource_id
string<uuid>
required
read-only

Unique identifier for the entity to enrich leads into

Example:

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

​
resource_type
enum<number>
required
read-only

Type of the entity to enrich leads into

Available options:
1,
2
Example:

1

​
limit
null | number

The maximum number of leads to enrich

Example:

100

​
enrichment_payload
object

Enrichment payload

​
auto_update
null | boolean

Whether new leads added to the resource will be automatically enriched using these same settings

Example:

true

​
skip_rows_without_email
null | boolean

Whether the fully enriched profile enrichment will run even if we don't find an email

Example:

true

​
in_progress
null | boolean

Whether the enrichment is in progress

Example:

true

​
type
enum<string>

Enrichment type to add to the resource

Available options:
work_email_enrichment,
fully_enriched_profile,
email_verification,
joblisting,
technologies,
news,
funding,
engagement_score,
ai_enrichment,
custom_flow
Example:

"email_verification"