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/search

Request body

application/json
providerIdstringrequired
criteriaobjectrequired
Show child parameters
titlesstring[]
= []
senioritiesstring[]
= []
industriesstring[]
= []
companySizesstring[]
= []
locationsstring[]
= []
technologiesstring[]
= []
domainsstring[]
= []
limitinteger
= 25
{
  "providerId": "string",
  "criteria": {
    "titles": [],
    "seniorities": [],
    "industries": [],
    "companySizes": [],
    "locations": [],
    "technologies": [],
    "domains": []
  },
  "limit": 25
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/leads/search" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"providerId":"string","criteria":{"titles":[],"seniorities":[],"industries":[],"companySizes":[],"locations":[],"technologies":[],"domains":[]},"limit":25}'
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
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
detailsobject
5XX Default Response

Same as 4XX · POST /v1/leads/search

GEThttps://hermeticor.com/v1/leads

Parameters

limitintegerquery
= 50
cursorstringquery
statusstringquery
preview | revealed | pushed

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/leads" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
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"
    }
  ],
  "nextCursor": "string"
}
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
nextCursorstringrequired
4XX Default Response

Same as 4XX · POST /v1/leads/search

5XX Default Response

Same as 4XX · POST /v1/leads/search

GEThttps://hermeticor.com/v1/leads/saved-searches

Parameters

limitintegerquery
Page size; omitted returns the whole list
cursorstringquery
Opaque: the nextCursor of the previous page

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/leads/saved-searches" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "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"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem116[]required
Show child parameters
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
nextCursorstringrequired
4XX Default Response

Same as 4XX · POST /v1/leads/search

5XX Default Response

Same as 4XX · POST /v1/leads/search

POSThttps://hermeticor.com/v1/leads/saved-searches

Request body

application/json
namestringrequired
providerIdstringrequired
criteriaobjectrequired
Show child parameters
titlesstring[]
= []
senioritiesstring[]
= []
industriesstring[]
= []
companySizesstring[]
= []
locationsstring[]
= []
technologiesstring[]
= []
domainsstring[]
= []
{
  "name": "string",
  "providerId": "string",
  "criteria": {
    "titles": [],
    "seniorities": [],
    "industries": [],
    "companySizes": [],
    "locations": [],
    "technologies": [],
    "domains": []
  }
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/leads/saved-searches" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","providerId":"string","criteria":{"titles":[],"seniorities":[],"industries":[],"companySizes":[],"locations":[],"technologies":[],"domains":[]}}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 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/search

5XX Default Response

Same as 4XX · POST /v1/leads/search

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

Parameters

idstringpathrequired

Code samples

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

Responses

200 Default Response

Same as 201 · POST /v1/leads/saved-searches

4XX Default Response

Same as 4XX · POST /v1/leads/search

5XX Default Response

Same as 4XX · POST /v1/leads/search

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

Parameters

idstringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/leads/saved-searches/{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/search

5XX Default Response

Same as 4XX · POST /v1/leads/search

Updated