leads

Embed
Preview of the card
<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>
POSThttps://hermeticor.com/v1/leads/company-lists

Request body

application/json
namestringrequired
descriptionstring
{
  "name": "string",
  "description": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/leads/company-lists" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","description":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "id": "string",
  "name": "string",
  "description": "string",
  "companyCount": 0,
  "createdAt": "2024-01-01T00:00:00Z"
}
Schema
idstringrequired
namestringrequired
descriptionstringrequired
companyCountintegerrequired
createdAtstringrequired
4XX Default Response
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · POST /v1/leads/company-lists

DELETEhttps://hermeticor.com/v1/leads/company-lists/{id}

Parameters

idstringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/leads/company-lists/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "ok": true
}
Schema
okbooleanrequired
true
4XX Default Response

Same as 4XX · POST /v1/leads/company-lists

5XX Default Response

Same as 4XX · POST /v1/leads/company-lists

GEThttps://hermeticor.com/v1/leads/company-lists/{id}/companies

Parameters

limitintegerquery
= 50
cursorstringquery
idstringpathrequired

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/leads/company-lists/{id}/companies" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
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 · POST /v1/leads/company-lists

5XX Default Response

Same as 4XX · POST /v1/leads/company-lists

POSThttps://hermeticor.com/v1/leads/company-lists/{id}/companies

Parameters

idstringpathrequired

Request body

application/json
companyIdsstring[]required
{
  "companyIds": [
    "string"
  ]
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/leads/company-lists/{id}/companies" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"companyIds":["string"]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "added": 0
}
Schema
addedintegerrequired
4XX Default Response

Same as 4XX · POST /v1/leads/company-lists

5XX Default Response

Same as 4XX · POST /v1/leads/company-lists

POSThttps://hermeticor.com/v1/leads/company-lists/{id}/companies/remove

Parameters

idstringpathrequired

Request body

application/json
companyIdsstring[]required
{
  "companyIds": [
    "string"
  ]
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/leads/company-lists/{id}/companies/remove" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"companyIds":["string"]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · DELETE /v1/leads/company-lists/{id}

4XX Default Response

Same as 4XX · POST /v1/leads/company-lists

5XX Default Response

Same as 4XX · POST /v1/leads/company-lists

POSThttps://hermeticor.com/v1/leads/companies/{id}/source-contacts

Find contacts at an account. With no titles given, the AI assistant proposes the buyer titles first

Parameters

idstringpathrequired

Request body

application/json
providerIdstringrequired
titlesstring[]
= []
senioritiesstring[]
= []
limitinteger
= 10
offerstring
{
  "providerId": "string",
  "titles": [],
  "seniorities": [],
  "limit": 10,
  "offer": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/leads/companies/{id}/source-contacts" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"providerId":"string","titles":[],"seniorities":[],"limit":10,"offer":"string"}'
TypeScript
Python
Go
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"
    }
  ],
  "cached": true
}
Schema
itemsItemsItem115[]required
Show child parameters
idstringrequired
providerKindstringrequired
firstNamestringrequired
lastNamestringrequired
titlestringrequired
companystringrequired
domainstringrequired
emailstringrequired
phonestringrequired
linkedinUrlstringrequired
countrystringrequired
hasEmailbooleanrequired
emailStatusstringrequired
valid | invalid | risky | catch_all | unknown | disposable
statusstringrequired
preview | revealed | pushed
profileIdstringrequired
provenanceobjectrequired
createdAtstringrequired
cachedbooleanrequired
4XX Default Response

Same as 4XX · POST /v1/leads/company-lists

5XX Default Response

Same as 4XX · POST /v1/leads/company-lists

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

Run a saved search now (and reveal emails if auto-enrich is on)

Parameters

idstringpathrequired

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/leads/saved-searches/{id}/run" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
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

Same as 4XX · POST /v1/leads/company-lists

5XX Default Response

Same as 4XX · POST /v1/leads/company-lists

POSThttps://hermeticor.com/v1/leads/waterfalls/{id}/reset

Put the waterfall back to your enabled finder providers in priority order

Parameters

idstringpathrequired

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/leads/waterfalls/{id}/reset" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "id": "string",
  "providerIds": [
    "string"
  ]
}
Schema
idstringrequired
providerIdsstring[]required
4XX Default Response

Same as 4XX · POST /v1/leads/company-lists

5XX Default Response

Same as 4XX · POST /v1/leads/company-lists

Updated