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>

PATCHhttps://hermeticor.com/v1/leads/saved-searches/{id}

Parameters

idstringpathrequired

Request body

application/json

namestring

criteriaobject

Show child parameters

titlesstring[]

= []

senioritiesstring[]

= []

industriesstring[]

= []

companySizesstring[]

= []

locationsstring[]

= []

technologiesstring[]

= []

domainsstring[]

= []

runEverystring

daily | weekly

autoEnrichboolean

maxResultsinteger

{
  "name": "string",
  "criteria": {
    "titles": [],
    "seniorities": [],
    "industries": [],
    "companySizes": [],
    "locations": [],
    "technologies": [],
    "domains": []
  },
  "runEvery": "daily",
  "autoEnrich": true,
  "maxResults": 0
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/leads/saved-searches/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","criteria":{"titles":[],"seniorities":[],"industries":[],"companySizes":[],"locations":[],"technologies":[],"domains":[]},"runEvery":"daily","autoEnrich":true,"maxResults":0}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "name": "string",
  "providerId": "string",
  "criteria": {
    "titles": [],
    "seniorities": [],
    "industries": [],
    "companySizes": [],
    "locations": [],
    "technologies": [],
    "domains": []
  },
  "createdAt": "2024-01-01T00:00:00Z",
  "runEvery": "daily",
  "autoEnrich": true,
  "maxResults": 0,
  "lastRunAt": "2024-01-01T00:00:00Z",
  "lastRunCount": 0,
  "lastError": "string"
}

Schema

idstringrequired

namestringrequired

providerIdstringrequired

criteriaobjectrequired

Show child parameters

titlesstring[]required

= []

senioritiesstring[]required

= []

industriesstring[]required

= []

companySizesstring[]required

= []

locationsstring[]required

= []

technologiesstring[]required

= []

domainsstring[]required

= []

createdAtstringrequired

runEverystringrequired

daily | weekly

autoEnrichbooleanrequired

maxResultsintegerrequired

lastRunAtstringrequired

lastRunCountintegerrequired

lastErrorstringrequired

4XX Default Response

Example

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

Schema

errorobjectrequired

Show child parameters

codestringrequired

messagestringrequired

detailsobject

5XX Default Response

Same as 4XX · PATCH /v1/leads/saved-searches/{id}

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

Reveal email (and phone) for previewed leads; spends provider credits once per lead

Request body

application/json

leadIdsstring[]required

{
  "leadIds": [
    "string"
  ]
}

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "providerKind": "string",
      "firstName": "string",
      "lastName": "string",
      "title": "string",
      "company": "string",
      "domain": "string",
      "email": "string",
      "phone": "string",
      "linkedinUrl": "string",
      "country": "string",
      "hasEmail": true,
      "emailStatus": "valid",
      "status": "preview",
      "profileId": "string",
      "provenance": {},
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "creditsSpent": 0,
  "errors": [
    {
      "leadId": "string",
      "error": "string"
    }
  ]
}

Schema

itemsItemsItem115[]required

Show child parameters

idstringrequired

providerKindstringrequired

firstNamestringrequired

lastNamestringrequired

titlestringrequired

companystringrequired

domainstringrequired

emailstringrequired

phonestringrequired

linkedinUrlstringrequired

countrystringrequired

hasEmailbooleanrequired

emailStatusstringrequired

statusstringrequired

preview | revealed | pushed

profileIdstringrequired

provenanceobjectrequired

createdAtstringrequired

creditsSpentintegerrequired

errorsobject[]required

Show child parameters

leadIdstringrequired

errorstringrequired

4XX Default Response

Same as 4XX · PATCH /v1/leads/saved-searches/{id}

5XX Default Response

Same as 4XX · PATCH /v1/leads/saved-searches/{id}

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

Verify, dedupe, apply DNC/jurisdiction gates, import as prospects and optionally enroll

Request body

application/json

leadIdsstring[]required

sequenceIdstring

policyobject

= {"skipInvalid":true,"skipRisky":true,"skipCatchAll":true,"skipUnknown":false,"skipRole":false}

Show child parameters

skipInvalidboolean

= true

skipRiskyboolean

= true

skipCatchAllboolean

= true

skipUnknownboolean

= false

skipRoleboolean

= false

{
  "leadIds": [
    "string"
  ],
  "sequenceId": "string",
  "policy": {
    "skipInvalid": true,
    "skipRisky": true,
    "skipCatchAll": true,
    "skipUnknown": false,
    "skipRole": false
  }
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/leads/push" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"leadIds":["string"],"sequenceId":"string","policy":{"skipInvalid":true,"skipRisky":true,"skipCatchAll":true,"skipUnknown":false,"skipRole":false}}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "imported": 0,
  "skipped": [
    {
      "ref": "string",
      "reason": "string"
    }
  ],
  "enroll": {
    "enrolled": 0,
    "skipped": [
      {
        "profileId": "string",
        "reason": "string"
      }
    ],
    "warnings": [
      {
        "profileId": "string",
        "warning": "string"
      }
    ]
  }
}

Schema

importedintegerrequired

skippedobject[]required

Show child parameters

refstringrequired

reasonstringrequired

enrollobjectrequired

Show child parameters

enrolledintegerrequired

skippedSkippedItem[]required

Show child parameters

profileIdstringrequired

reasonstringrequired

warningsWarningsItem[]required

Show child parameters

profileIdstringrequired

warningstringrequired

4XX Default Response

Same as 4XX · PATCH /v1/leads/saved-searches/{id}

5XX Default Response

Same as 4XX · PATCH /v1/leads/saved-searches/{id}

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

CSV lead import with verification policy (rows already parsed)

Request body

application/json

rowsobject[]required

Show child parameters

emailstringrequired

firstNamestring

lastNamestring

titlestring

companystring

websitestring

linkedinUrlstring

countrystring

timezonestring

customFieldsobject

= {}

sequenceIdstring

policyobject

= {"skipInvalid":true,"skipRisky":true,"skipCatchAll":true,"skipUnknown":false,"skipRole":false}

Show child parameters

skipInvalidboolean

= true

skipRiskyboolean

= true

skipCatchAllboolean

= true

skipUnknownboolean

= false

skipRoleboolean

= false

{
  "rows": [
    {
      "email": "string",
      "firstName": "string",
      "lastName": "string",
      "title": "string",
      "company": "string",
      "website": "string",
      "linkedinUrl": "string",
      "country": "string",
      "timezone": "string",
      "customFields": {}
    }
  ],
  "sequenceId": "string",
  "policy": {
    "skipInvalid": true,
    "skipRisky": true,
    "skipCatchAll": true,
    "skipUnknown": false,
    "skipRole": false
  }
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/leads/import" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"rows":[{"email":"string","firstName":"string","lastName":"string","title":"string","company":"string","website":"string","linkedinUrl":"string","country":"string","timezone":"string","customFields":{}}],"sequenceId":"string","policy":{"skipInvalid":true,"skipRisky":true,"skipCatchAll":true,"skipUnknown":false,"skipRole":false}}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 200 · POST /v1/leads/push

4XX Default Response

Same as 4XX · PATCH /v1/leads/saved-searches/{id}

5XX Default Response

Same as 4XX · PATCH /v1/leads/saved-searches/{id}

GEThttps://hermeticor.com/v1/leads/{id}

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "providerKind": "string",
  "firstName": "string",
  "lastName": "string",
  "title": "string",
  "company": "string",
  "domain": "string",
  "email": "string",
  "phone": "string",
  "linkedinUrl": "string",
  "country": "string",
  "hasEmail": true,
  "emailStatus": "valid",
  "status": "preview",
  "profileId": "string",
  "provenance": {},
  "createdAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

providerKindstringrequired

firstNamestringrequired

lastNamestringrequired

titlestringrequired

companystringrequired

domainstringrequired

emailstringrequired

phonestringrequired

linkedinUrlstringrequired

countrystringrequired

hasEmailbooleanrequired

emailStatusstringrequired

statusstringrequired

preview | revealed | pushed

profileIdstringrequired

provenanceobjectrequired

createdAtstringrequired

4XX Default Response

Same as 4XX · PATCH /v1/leads/saved-searches/{id}

5XX Default Response

Same as 4XX · PATCH /v1/leads/saved-searches/{id}

GEThttps://hermeticor.com/v1/leads/lists/{id}/verification-stats

Stored email verification results for the people on a list

Parameters

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/leads/lists/{id}/verification-stats" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "listId": "string",
  "members": 0,
  "withEmail": 0,
  "unverified": 0,
  "byStatus": {},
  "estimatedBounceRate": 0,
  "truncated": true
}

Schema

listIdstringrequired

membersintegerrequired

withEmailintegerrequired

unverifiedintegerrequired

byStatusobjectrequired

estimatedBounceRatenumberrequired

truncatedbooleanrequired

4XX Default Response

Same as 4XX · PATCH /v1/leads/saved-searches/{id}

5XX Default Response

Same as 4XX · PATCH /v1/leads/saved-searches/{id}

Next part

Updated Nov 8, 2026

Was this page helpful?