Enrich by domain
Cost: 1 credit per call
Enriches a company using its domain name as lookup parameter.
We map each domain to a unique company so lookups via domain are fast and reliable. It is the preferred way to enrich a company.
In case the domain name could not be enriched, the API will return a 404 error.
Set waitForEnrichment=false to skip waiting for on-demand enrichment. Already stored company data is returned immediately. When the company is not stored yet, the API returns a 404 error without charging any credits and schedules the enrichment in the background, so a later call can return the company quickly.
Request
- Base URL: https://api.companyenrich.com
- URL: https://api.companyenrich.com/companies/enrich
- Auth: API key in header Authorization
Query parameters
Expandable response fields. Repeat the parameter to request multiple expansions.
Supported values:
- workforce: costs 5 credits per company and adds the workforce field to CompanyInfo.
Whether to wait for on-demand enrichment when the company is not stored yet. When false, stored company data is returned immediately; a company that is not stored yet results in a 404 without charging credits, and its enrichment is scheduled in the background so a later call can return it quickly.
Response
OK
Changes
No recorded changes to this operation across all 1 revision of this API.