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>
GEThttps://hermeticor.com/v1/leads/providers

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/providers" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "kind": "apollo",
      "role": "finder",
      "name": "string",
      "priority": 0,
      "enabled": true,
      "creditsUsed": 0,
      "creditLimit": 0,
      "createdAt": "2024-01-01T00:00:00Z",
      "keyVerified": true
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem114[]required
Show child parameters
idstringrequired
kindstringrequired
apollo | hunter | pdl | dropcontact | findymail | zerobounce | neverbounce | kickbox | millionverifier | smtp | twilio_lookup | telnyx_lookup
rolestringrequired
finder | verifier | phone
namestringrequired
priorityintegerrequired
enabledbooleanrequired
creditsUsedintegerrequired
creditLimitintegerrequired
createdAtstringrequired
keyVerifiedbooleanrequired
false: the key is stored unchecked; a rejected key shows on first use as 502 provider_error. null: no key (smtp)
nextCursorstringrequired
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/providers

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

Request body

application/json
kindstringrequired
apollo | hunter | pdl | dropcontact | findymail | zerobounce | neverbounce | kickbox | millionverifier | smtp | twilio_lookup | telnyx_lookup
namestringrequired
apiKeystring
priorityinteger
= 100
creditLimitinteger
{
  "kind": "apollo",
  "name": "string",
  "apiKey": "string",
  "priority": 100,
  "creditLimit": 0
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/leads/providers" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"kind":"apollo","name":"string","apiKey":"string","priority":100,"creditLimit":0}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "id": "string",
  "kind": "apollo",
  "role": "finder",
  "name": "string",
  "priority": 0,
  "enabled": true,
  "creditsUsed": 0,
  "creditLimit": 0,
  "createdAt": "2024-01-01T00:00:00Z",
  "keyVerified": true
}
Schema
idstringrequired
kindstringrequired
apollo | hunter | pdl | dropcontact | findymail | zerobounce | neverbounce | kickbox | millionverifier | smtp | twilio_lookup | telnyx_lookup
rolestringrequired
finder | verifier | phone
namestringrequired
priorityintegerrequired
enabledbooleanrequired
creditsUsedintegerrequired
creditLimitintegerrequired
createdAtstringrequired
keyVerifiedbooleanrequired
false: the key is stored unchecked; a rejected key shows on first use as 502 provider_error. null: no key (smtp)
4XX Default Response

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

5XX Default Response

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

DELETEhttps://hermeticor.com/v1/leads/providers/{id}

Parameters

idstringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/leads/providers/{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 · GET /v1/leads/providers

5XX Default Response

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

PATCHhttps://hermeticor.com/v1/leads/providers/{id}

Parameters

idstringpathrequired

Request body

application/json
enabledboolean
priorityinteger
creditLimitinteger
{
  "enabled": true,
  "priority": 0,
  "creditLimit": 0
}

Code samples

cURL
curl -X PATCH "https://hermeticor.com/v1/leads/providers/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"enabled":true,"priority":0,"creditLimit":0}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 201 · POST /v1/leads/providers

4XX Default Response

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

5XX Default Response

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

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

Code samples

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

Responses

200 Default Response
Example
{
  "providers": [
    {
      "id": "string",
      "name": "string",
      "kind": "apollo",
      "used": 0,
      "limit": 0
    }
  ],
  "totalUsed": 0
}
Schema
providersobject[]required
Show child parameters
idstringrequired
namestringrequired
kindstringrequired
apollo | hunter | pdl | dropcontact | findymail | zerobounce | neverbounce | kickbox | millionverifier | smtp | twilio_lookup | telnyx_lookup
usedintegerrequired
limitintegerrequired
totalUsedintegerrequired
4XX Default Response

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

5XX Default Response

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

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

Searches run recently, newest first

Parameters

limitintegerquery
= 50

Code samples

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

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "providerId": "string",
      "criteria": {
        "titles": [],
        "seniorities": [],
        "industries": [],
        "companySizes": [],
        "locations": [],
        "technologies": [],
        "domains": []
      },
      "resultCount": 0,
      "runs": 0,
      "updatedAt": "2024-01-01T00:00:00Z"
    }
  ]
}
Schema
itemsobject[]required
Show child parameters
idstringrequired
providerIdstringrequired
criteriaobjectrequired
Show child parameters
titlesstring[]required
= []
senioritiesstring[]required
= []
industriesstring[]required
= []
companySizesstring[]required
= []
locationsstring[]required
= []
technologiesstring[]required
= []
domainsstring[]required
= []
resultCountintegerrequired
runsintegerrequired
updatedAtstringrequired
4XX Default Response

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

5XX Default Response

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

DELETEhttps://hermeticor.com/v1/leads/recent-searches

Code samples

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

Responses

200 Default Response

Same as 200 · DELETE /v1/leads/providers/{id}

4XX Default Response

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

5XX Default Response

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

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

Parameters

idstringpathrequired

Code samples

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

Responses

200 Default Response

Same as 200 · DELETE /v1/leads/providers/{id}

4XX Default Response

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

5XX Default Response

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

Updated