|
| 1 | +--- |
| 2 | +title: FullEnrich |
| 3 | +description: Enrich contacts and search or look up people and companies |
| 4 | +--- |
| 5 | + |
| 6 | +import { BlockInfoCard } from "@/components/ui/block-info-card" |
| 7 | + |
| 8 | +<BlockInfoCard |
| 9 | + type="fullenrich" |
| 10 | + color="#8164F4" |
| 11 | +/> |
| 12 | + |
| 13 | +## Usage Instructions |
| 14 | + |
| 15 | +Use FullEnrich to enrich batches of contacts with work emails, personal emails, and mobile phones; reverse email addresses; search people and companies; and retrieve standalone person or company profiles. |
| 16 | + |
| 17 | + |
| 18 | + |
| 19 | +## Actions |
| 20 | + |
| 21 | +### FullEnrich Get Contact Enrichment |
| 22 | + |
| 23 | +Retrieve the status, contact records, and historical credit usage for an enrichment. |
| 24 | + |
| 25 | +#### Input |
| 26 | + |
| 27 | +| Parameter | Type | Required | Description | |
| 28 | +| --------- | ---- | -------- | ----------- | |
| 29 | +| `apiKey` | string | Yes | FullEnrich API key | |
| 30 | +| `enrichmentId` | string | Yes | Enrichment ID returned by Start Contact Enrichment | |
| 31 | +| `forceResults` | boolean | No | Return available records before the whole enrichment finishes | |
| 32 | + |
| 33 | +#### Output |
| 34 | + |
| 35 | +| Parameter | Type | Description | |
| 36 | +| --------- | ---- | ----------- | |
| 37 | +| `id` | string | Enrichment ID | |
| 38 | +| `name` | string | Enrichment name | |
| 39 | +| `status` | string | Current enrichment status | |
| 40 | +| `records` | array | Contact enrichment records with input, custom, contact_info, and profile fields | |
| 41 | +| ↳ `input` | json | Original contact enrichment input | |
| 42 | +| ↳ `custom` | json | Custom string fields returned unchanged | |
| 43 | +| ↳ `contact_info` | json | Found work emails, personal emails, and mobile phones | |
| 44 | +| ↳ `profile` | json | Full professional person profile | |
| 45 | +| `costCredits` | number | Historical credits consumed by the enrichment; retrieval itself is free | |
| 46 | + |
| 47 | +### FullEnrich Get Reverse Email |
| 48 | + |
| 49 | +Retrieve the status, matched profiles, and historical credit usage for a reverse lookup. |
| 50 | + |
| 51 | +#### Input |
| 52 | + |
| 53 | +| Parameter | Type | Required | Description | |
| 54 | +| --------- | ---- | -------- | ----------- | |
| 55 | +| `apiKey` | string | Yes | FullEnrich API key | |
| 56 | +| `enrichmentId` | string | Yes | Enrichment ID returned by Start Reverse Email | |
| 57 | + |
| 58 | +#### Output |
| 59 | + |
| 60 | +| Parameter | Type | Description | |
| 61 | +| --------- | ---- | ----------- | |
| 62 | +| `id` | string | Reverse lookup ID | |
| 63 | +| `name` | string | Reverse lookup name | |
| 64 | +| `status` | string | Current reverse-lookup status | |
| 65 | +| `records` | array | Reverse-email records with input, custom, and matched profile fields | |
| 66 | +| ↳ `input` | json | Original email input | |
| 67 | +| ↳ `custom` | json | Custom string fields returned unchanged | |
| 68 | +| ↳ `profile` | json | Matched professional person profile | |
| 69 | +| `costCredits` | number | Historical credits consumed by the lookup; retrieval itself is free | |
| 70 | + |
| 71 | +### FullEnrich Lookup Company |
| 72 | + |
| 73 | +Look up one company by domain or professional-network URL or ID. |
| 74 | + |
| 75 | +#### Input |
| 76 | + |
| 77 | +| Parameter | Type | Required | Description | |
| 78 | +| --------- | ---- | -------- | ----------- | |
| 79 | +| `apiKey` | string | Yes | FullEnrich API key | |
| 80 | +| `domain` | string | No | Company domain | |
| 81 | +| `professionalNetworkUrl` | string | No | Professional-network URL of the company | |
| 82 | +| `professionalNetworkId` | number | No | Professional-network ID of the company | |
| 83 | + |
| 84 | +#### Output |
| 85 | + |
| 86 | +| Parameter | Type | Description | |
| 87 | +| --------- | ---- | ----------- | |
| 88 | +| `companies` | array | Companies returned by FullEnrich | |
| 89 | +| ↳ `id` | string | FullEnrich company identifier | |
| 90 | +| ↳ `name` | string | Company name | |
| 91 | +| ↳ `domain` | string | Company domain | |
| 92 | +| ↳ `website` | string | Company website | |
| 93 | +| ↳ `description` | string | Company description | |
| 94 | +| ↳ `year_founded` | number | Year founded | |
| 95 | +| ↳ `headcount` | number | Exact employee count | |
| 96 | +| ↳ `headcount_range` | string | Employee-count range | |
| 97 | +| ↳ `company_type` | string | Company type | |
| 98 | +| ↳ `locations` | json | Headquarters and office locations | |
| 99 | +| ↳ `social_profiles` | json | Professional-network profile details | |
| 100 | +| ↳ `specialties` | json | Company specialties | |
| 101 | +| ↳ `industry` | json | Company industry information | |
| 102 | +| ↳ `logo_url` | string | FullEnrich-hosted company logo URL | |
| 103 | +| `credits` | number | Credits reported by FullEnrich for this lookup | |
| 104 | + |
| 105 | +### FullEnrich Lookup Person |
| 106 | + |
| 107 | +Look up one person by name, professional-network URL or ID, optionally disambiguated by company. |
| 108 | + |
| 109 | +#### Input |
| 110 | + |
| 111 | +| Parameter | Type | Required | Description | |
| 112 | +| --------- | ---- | -------- | ----------- | |
| 113 | +| `apiKey` | string | Yes | FullEnrich API key | |
| 114 | +| `personName` | string | No | Full name of the person | |
| 115 | +| `personProfessionalNetworkUrl` | string | No | Professional-network profile URL of the person | |
| 116 | +| `personProfessionalNetworkId` | number | No | Professional-network profile ID of the person | |
| 117 | +| `companyProfessionalNetworkUrl` | string | No | Professional-network URL of the company used to disambiguate a name | |
| 118 | +| `companyProfessionalNetworkId` | number | No | Professional-network ID of the company used to disambiguate a name | |
| 119 | +| `companyDomain` | string | No | Company domain used to disambiguate a name | |
| 120 | + |
| 121 | +#### Output |
| 122 | + |
| 123 | +| Parameter | Type | Description | |
| 124 | +| --------- | ---- | ----------- | |
| 125 | +| `people` | array | People returned by FullEnrich | |
| 126 | +| ↳ `id` | string | FullEnrich person identifier | |
| 127 | +| ↳ `full_name` | string | Full name | |
| 128 | +| ↳ `first_name` | string | First name | |
| 129 | +| ↳ `last_name` | string | Last name | |
| 130 | +| ↳ `headline` | string | Professional headline | |
| 131 | +| ↳ `description` | string | Professional profile summary | |
| 132 | +| ↳ `location` | json | Structured person location | |
| 133 | +| ↳ `social_profiles` | json | Professional-network profile details | |
| 134 | +| ↳ `educations` | json | Education history | |
| 135 | +| ↳ `languages` | json | Languages and proficiency | |
| 136 | +| ↳ `skills` | json | Professional skills | |
| 137 | +| ↳ `employment` | json | Current and past employment | |
| 138 | +| `credits` | number | Credits reported by FullEnrich for this lookup | |
| 139 | + |
| 140 | +### FullEnrich Search Companies |
| 141 | + |
| 142 | +Search FullEnrich companies by name, domain, professional network, keywords, industry, type, location, founding year, and headcount. |
| 143 | + |
| 144 | +#### Input |
| 145 | + |
| 146 | +| Parameter | Type | Required | Description | |
| 147 | +| --------- | ---- | -------- | ----------- | |
| 148 | +| `apiKey` | string | Yes | FullEnrich API key | |
| 149 | +| `filters` | json | No | Official company-search filter object. Supported keys: names, domains, professional_network_ids, professional_network_urls, keywords, specialties, industries, types, headquarters_locations, founded_years, headcounts, and company_ids. | |
| 150 | +| `offset` | number | No | Number of companies to skip, from 0 to 10,000 | |
| 151 | +| `limit` | number | No | Number of companies to return, from 1 to 100; defaults to 10 | |
| 152 | +| `searchAfter` | string | No | Cursor returned by the previous response for cursor-based pagination | |
| 153 | + |
| 154 | +#### Output |
| 155 | + |
| 156 | +| Parameter | Type | Description | |
| 157 | +| --------- | ---- | ----------- | |
| 158 | +| `companies` | array | Companies returned by FullEnrich | |
| 159 | +| ↳ `id` | string | FullEnrich company identifier | |
| 160 | +| ↳ `name` | string | Company name | |
| 161 | +| ↳ `domain` | string | Company domain | |
| 162 | +| ↳ `website` | string | Company website | |
| 163 | +| ↳ `description` | string | Company description | |
| 164 | +| ↳ `year_founded` | number | Year founded | |
| 165 | +| ↳ `headcount` | number | Exact employee count | |
| 166 | +| ↳ `headcount_range` | string | Employee-count range | |
| 167 | +| ↳ `company_type` | string | Company type | |
| 168 | +| ↳ `locations` | json | Headquarters and office locations | |
| 169 | +| ↳ `social_profiles` | json | Professional-network profile details | |
| 170 | +| ↳ `specialties` | json | Company specialties | |
| 171 | +| ↳ `industry` | json | Company industry information | |
| 172 | +| ↳ `logo_url` | string | FullEnrich-hosted company logo URL | |
| 173 | +| `total` | number | Total number of matching companies | |
| 174 | +| `credits` | number | Credits reported by FullEnrich for this request | |
| 175 | +| `offset` | number | Number of results skipped | |
| 176 | +| `searchAfter` | string | Cursor for the next page | |
| 177 | + |
| 178 | +### FullEnrich Search People |
| 179 | + |
| 180 | +Search FullEnrich people by company, identity, location, skills, role, seniority, employment, and education filters. |
| 181 | + |
| 182 | +#### Input |
| 183 | + |
| 184 | +| Parameter | Type | Required | Description | |
| 185 | +| --------- | ---- | -------- | ----------- | |
| 186 | +| `apiKey` | string | Yes | FullEnrich API key | |
| 187 | +| `filters` | json | No | Official people-search filter object. Supported keys include current_company_names, current_company_domains, current_position_titles, person_locations, person_skills, and all other documented v2 filters. | |
| 188 | +| `offset` | number | No | Number of people to skip, from 0 to 10,000 | |
| 189 | +| `limit` | number | No | Number of people to return, from 1 to 100; defaults to 10 | |
| 190 | +| `searchAfter` | string | No | Cursor returned by the previous response for cursor-based pagination | |
| 191 | + |
| 192 | +#### Output |
| 193 | + |
| 194 | +| Parameter | Type | Description | |
| 195 | +| --------- | ---- | ----------- | |
| 196 | +| `people` | array | People returned by FullEnrich | |
| 197 | +| ↳ `id` | string | FullEnrich person identifier | |
| 198 | +| ↳ `full_name` | string | Full name | |
| 199 | +| ↳ `first_name` | string | First name | |
| 200 | +| ↳ `last_name` | string | Last name | |
| 201 | +| ↳ `headline` | string | Professional headline | |
| 202 | +| ↳ `description` | string | Professional profile summary | |
| 203 | +| ↳ `location` | json | Structured person location | |
| 204 | +| ↳ `social_profiles` | json | Professional-network profile details | |
| 205 | +| ↳ `educations` | json | Education history | |
| 206 | +| ↳ `languages` | json | Languages and proficiency | |
| 207 | +| ↳ `skills` | json | Professional skills | |
| 208 | +| ↳ `employment` | json | Current and past employment | |
| 209 | +| `total` | number | Total number of matching people | |
| 210 | +| `credits` | number | Credits reported by FullEnrich for this request | |
| 211 | +| `offset` | number | Number of results skipped | |
| 212 | +| `searchAfter` | string | Cursor for the next page | |
| 213 | + |
| 214 | +### FullEnrich Start Contact Enrichment |
| 215 | + |
| 216 | +Start an asynchronous enrichment of up to 100 contacts for work emails, personal emails, and mobile phones. |
| 217 | + |
| 218 | +#### Input |
| 219 | + |
| 220 | +| Parameter | Type | Required | Description | |
| 221 | +| --------- | ---- | -------- | ----------- | |
| 222 | +| `apiKey` | string | Yes | FullEnrich API key | |
| 223 | +| `name` | string | Yes | Readable enrichment name shown in the FullEnrich dashboard | |
| 224 | +| `data` | json | Yes | Array of 1-100 contacts. Each requires linkedin_url, or first_name + last_name with domain/company_name, plus enrich_fields. | |
| 225 | +| `webhookUrl` | string | No | HTTPS endpoint notified when the entire enrichment finishes | |
| 226 | +| `contactFinishedWebhookUrl` | string | No | HTTPS endpoint notified when each contact finishes | |
| 227 | + |
| 228 | +#### Output |
| 229 | + |
| 230 | +| Parameter | Type | Description | |
| 231 | +| --------- | ---- | ----------- | |
| 232 | +| `enrichmentId` | string | ID used to retrieve asynchronous enrichment results | |
| 233 | + |
| 234 | +### FullEnrich Start Reverse Email |
| 235 | + |
| 236 | +Start an asynchronous reverse lookup of up to 100 email addresses. |
| 237 | + |
| 238 | +#### Input |
| 239 | + |
| 240 | +| Parameter | Type | Required | Description | |
| 241 | +| --------- | ---- | -------- | ----------- | |
| 242 | +| `apiKey` | string | Yes | FullEnrich API key | |
| 243 | +| `name` | string | Yes | Readable reverse-lookup name shown in the FullEnrich dashboard | |
| 244 | +| `data` | json | Yes | Array of 1-100 objects containing email and optional string-valued custom fields | |
| 245 | +| `webhookUrl` | string | No | HTTPS endpoint notified when the entire lookup finishes | |
| 246 | +| `contactFinishedWebhookUrl` | string | No | HTTPS endpoint notified when each email finishes | |
| 247 | + |
| 248 | +#### Output |
| 249 | + |
| 250 | +| Parameter | Type | Description | |
| 251 | +| --------- | ---- | ----------- | |
| 252 | +| `enrichmentId` | string | ID used to retrieve asynchronous reverse-email results | |
| 253 | + |
| 254 | + |
0 commit comments