leads

Embed

<a href="https://hermeticor.com/docs/ref-leads"><img src="https://hermeticor.com/docs/_api/public/orgs/5fcd8b3c-a27c-4688-972f-de710125592f/spaces/caf5dc05-15f7-4e0c-bdb8-ab29ede6211e/pages/6a4b46f7-1819-4605-adbe-80ba535f35d4/social-card.svg?v=3e7ae33eec8b" alt="leads" width="600" height="315"></a>

GEThttps://hermeticor.com/v1/leads/settings

Auto-enrichment on search (uses your own provider credits)

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/leads/settings" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "autoEnrichOnSearch": true,
  "maxAutoEnrichPerSearch": 0
}

Schema

autoEnrichOnSearchbooleanrequired

maxAutoEnrichPerSearchintegerrequired

4XX Default Response

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · GET /v1/leads/settings

PUThttps://hermeticor.com/v1/leads/settings

Request body

application/json

autoEnrichOnSearchboolean

maxAutoEnrichPerSearchinteger

{
  "autoEnrichOnSearch": true,
  "maxAutoEnrichPerSearch": 0
}

Code samples

cURL

curl -X PUT "https://hermeticor.com/v1/leads/settings" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"autoEnrichOnSearch":true,"maxAutoEnrichPerSearch":0}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · GET /v1/leads/settings

4XX Default Response

Same as 4XX · GET /v1/leads/settings

5XX Default Response

Same as 4XX · GET /v1/leads/settings

POSThttps://hermeticor.com/v1/leads/verify

Request body

application/json

emailstringrequired

forceboolean

= false

{
  "email": "string",
  "force": false
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/leads/verify" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email":"string","force":false}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "email": "string",
  "status": "valid",
  "risk": 0,
  "flags": [
    "string"
  ],
  "provider": "string",
  "checkedAt": "2024-01-01T00:00:00Z"
}

Schema

emailstringrequired

statusstringrequired

riskintegerrequired

flagsstring[]required

providerstringrequired

checkedAtstringrequired

4XX Default Response

Same as 4XX · GET /v1/leads/settings

5XX Default Response

Same as 4XX · GET /v1/leads/settings

GEThttps://hermeticor.com/v1/leads/verify/{email}

Stored verification result for an address (404 until it has been verified)

Parameters

emailstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/leads/verify/{email}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · POST /v1/leads/verify

4XX Default Response

Same as 4XX · GET /v1/leads/settings

5XX Default Response

Same as 4XX · GET /v1/leads/settings

POSThttps://hermeticor.com/v1/leads/disposable-domains

Request body

application/json

domainsstring[]required

{
  "domains": [
    "string"
  ]
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/leads/disposable-domains" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"domains":["string"]}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "added": 0
}

Schema

addedintegerrequired

4XX Default Response

Same as 4XX · GET /v1/leads/settings

5XX Default Response

Same as 4XX · GET /v1/leads/settings

GEThttps://hermeticor.com/v1/leads/companies

Parameters

limitintegerquery

= 50

cursorstringquery

qstringquery

suppressedbooleanquery

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/leads/companies" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "domain": "string",
      "name": "string",
      "industry": "string",
      "sizeBand": "string",
      "country": "string",
      "suppressed": true,
      "suppressionReason": "string",
      "leadCount": 0,
      "contactCount": 0,
      "createdAt": "2024-01-01T00:00:00Z",
      "stage": "string",
      "ownerUserId": "string",
      "customFields": {},
      "score": 0
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem117[]required

Show child parameters

idstringrequired

domainstringrequired

namestringrequired

industrystringrequired

sizeBandstringrequired

countrystringrequired

suppressedbooleanrequired

suppressionReasonstringrequired

leadCountintegerrequired

contactCountintegerrequired

createdAtstringrequired

stagestring

ownerUserIdstring

customFieldsobject

scoreinteger

nextCursorstringrequired

4XX Default Response

Same as 4XX · GET /v1/leads/settings

5XX Default Response

Same as 4XX · GET /v1/leads/settings

POSThttps://hermeticor.com/v1/leads/companies

Create a company by domain. 201 when created; 200 with the existing company (unchanged: PATCH it) when the domain is already known

Request body

application/json

domainstringrequired

namestring

industrystring

sizeBandstring

countrystring

customFieldsobject

{
  "domain": "string",
  "name": "string",
  "industry": "string",
  "sizeBand": "string",
  "country": "string",
  "customFields": {}
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/leads/companies" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"domain":"string","name":"string","industry":"string","sizeBand":"string","country":"string","customFields":{}}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "domain": "string",
  "name": "string",
  "industry": "string",
  "sizeBand": "string",
  "country": "string",
  "suppressed": true,
  "suppressionReason": "string",
  "leadCount": 0,
  "contactCount": 0,
  "createdAt": "2024-01-01T00:00:00Z",
  "stage": "string",
  "ownerUserId": "string",
  "customFields": {},
  "score": 0
}

Schema

idstringrequired

domainstringrequired

namestringrequired

industrystringrequired

sizeBandstringrequired

countrystringrequired

suppressedbooleanrequired

suppressionReasonstringrequired

leadCountintegerrequired

contactCountintegerrequired

createdAtstringrequired

stagestring

ownerUserIdstring

customFieldsobject

scoreinteger

4XX Default Response

Same as 4XX · GET /v1/leads/settings

5XX Default Response

Same as 4XX · GET /v1/leads/settings

POSThttps://hermeticor.com/v1/leads/companies/import

Create or update up to 1000 companies by domain; a company that already exists is kept as it is, a bad domain is reported by row

Request body

application/json

rowsPostV1LeadsCompaniesBody[]required

Show child parameters

domainstringrequired

namestring

industrystring

sizeBandstring

countrystring

customFieldsobject

{
  "rows": [
    {
      "domain": "string",
      "name": "string",
      "industry": "string",
      "sizeBand": "string",
      "country": "string",
      "customFields": {}
    }
  ]
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/leads/companies/import" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"rows":[{"domain":"string","name":"string","industry":"string","sizeBand":"string","country":"string","customFields":{}}]}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "imported": 0,
  "skipped": [
    {
      "row": 0,
      "domain": "string",
      "reason": "string"
    }
  ]
}

Schema

importedintegerrequired

skippedSkippedItem2[]required

Show child parameters

rowintegerrequired

domainstringrequired

reasonstringrequired

4XX Default Response

Same as 4XX · GET /v1/leads/settings

5XX Default Response

Same as 4XX · GET /v1/leads/settings

Next part

Updated Nov 8, 2026

Was this page helpful?