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/companies/{id}

Parameters

idstringpathrequired

Code samples

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

Responses

200 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,
  "leads": [
    {
      "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"
    }
  ],
  "profileIds": [
    "string"
  ],
  "contacts": [
    {
      "isPrimary": true,
      "jobTitle": "string",
      "role": "string",
      "profileId": "string"
    }
  ]
}
Schema
idstringrequired
domainstringrequired
namestringrequired
industrystringrequired
sizeBandstringrequired
countrystringrequired
suppressedbooleanrequired
suppressionReasonstringrequired
leadCountintegerrequired
contactCountintegerrequired
createdAtstringrequired
stagestring
ownerUserIdstring
customFieldsobject
scoreinteger
leadsItemsItem115[]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
profileIdsstring[]required
contactsContactsItem[]
Show child parameters
isPrimarybooleanrequired
jobTitlestringrequired
rolestringrequired
profileIdstringrequired
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/companies/{id}

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

Parameters

idstringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/leads/companies/{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/companies/{id}

5XX Default Response

Same as 4XX · GET /v1/leads/companies/{id}

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

Parameters

idstringpathrequired

Request body

application/json
namestring
industrystring
sizeBandstring
countrystring
customFieldsobject
{
  "name": "string",
  "industry": "string",
  "sizeBand": "string",
  "country": "string",
  "customFields": {}
}

Code samples

cURL
curl -X PATCH "https://hermeticor.com/v1/leads/companies/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","industry":"string","sizeBand":"string","country":"string","customFields":{}}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · GET /v1/leads/companies/{id}

4XX Default Response

Same as 4XX · GET /v1/leads/companies/{id}

5XX Default Response

Same as 4XX · GET /v1/leads/companies/{id}

POSThttps://hermeticor.com/v1/leads/companies/{id}/suppress

Do not contact anyone at this domain (consent domain blocklist)

Parameters

idstringpathrequired

Request body

application/json
reasonstring
{
  "reason": "string"
}

Code samples

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

Responses

200 Default Response

Same as 200 · GET /v1/leads/companies/{id}

4XX Default Response

Same as 4XX · GET /v1/leads/companies/{id}

5XX Default Response

Same as 4XX · GET /v1/leads/companies/{id}

POSThttps://hermeticor.com/v1/leads/companies/{id}/unsuppress

Parameters

idstringpathrequired

Code samples

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

Responses

200 Default Response

Same as 200 · GET /v1/leads/companies/{id}

4XX Default Response

Same as 4XX · GET /v1/leads/companies/{id}

5XX Default Response

Same as 4XX · GET /v1/leads/companies/{id}

POSThttps://hermeticor.com/v1/leads/companies/{id}/link

Parameters

idstringpathrequired

Request body

application/json
profileIdstringrequired
primaryboolean
jobTitlestring
rolestring
{
  "profileId": "string",
  "primary": true,
  "jobTitle": "string",
  "role": "string"
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/leads/companies/{id}/link" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"profileId":"string","primary":true,"jobTitle":"string","role":"string"}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 200 · GET /v1/leads/companies/{id}

4XX Default Response

Same as 4XX · GET /v1/leads/companies/{id}

5XX Default Response

Same as 4XX · GET /v1/leads/companies/{id}

DELETEhttps://hermeticor.com/v1/leads/companies/{id}/link/{profileId}

Parameters

idstringpathrequired
profileIdstringpathrequired

Code samples

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

Responses

200 Default Response

Same as 200 · GET /v1/leads/companies/{id}

4XX Default Response

Same as 4XX · GET /v1/leads/companies/{id}

5XX Default Response

Same as 4XX · GET /v1/leads/companies/{id}

GEThttps://hermeticor.com/v1/profiles/{id}/companies

Every company this contact is linked to, primary first, with the link fields

Parameters

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

Code samples

cURL
curl -X GET "https://hermeticor.com/v1/profiles/{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,
      "link": {
        "isPrimary": true,
        "jobTitle": "string",
        "role": "string"
      }
    }
  ],
  "nextCursor": "string"
}
Schema
itemsobject[]required
Show child parameters
idstringrequired
domainstringrequired
namestringrequired
industrystringrequired
sizeBandstringrequired
countrystringrequired
suppressedbooleanrequired
suppressionReasonstringrequired
leadCountintegerrequired
contactCountintegerrequired
createdAtstringrequired
stagestring
ownerUserIdstring
customFieldsobject
scoreinteger
linkobject
Show child parameters
isPrimarybooleanrequired
jobTitlestringrequired
rolestringrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /v1/leads/companies/{id}

5XX Default Response

Same as 4XX · GET /v1/leads/companies/{id}

POSThttps://hermeticor.com/v1/leads/phone-lookup

Request body

application/json
phonestringrequired
countrystring
forceboolean
= false
{
  "phone": "string",
  "country": "string",
  "force": false
}

Code samples

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

Responses

200 Default Response
Example
{
  "phone": "string",
  "lineType": "mobile",
  "carrier": "string",
  "landline": true,
  "provider": "string",
  "checkedAt": "2024-01-01T00:00:00Z"
}
Schema
phonestringrequired
lineTypestringrequired
mobile | landline | voip | toll_free | other | unknown
carrierstringrequired
landlinebooleanrequired
providerstringrequired
checkedAtstringrequired
4XX Default Response

Same as 4XX · GET /v1/leads/companies/{id}

5XX Default Response

Same as 4XX · GET /v1/leads/companies/{id}

Updated