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/company-fields

Custom company fields

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

Responses

200 Default Response
Example
{
  "items": [
    {
      "key": "string",
      "label": "string",
      "type": "text",
      "options": [
        "string"
      ],
      "required": true,
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem238[]required
Show child parameters
keystringrequired
labelstringrequired
typestringrequired
text | number | boolean | date | select | url
optionsstring[]required
requiredbooleanrequired
createdAtstringrequired
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/company-fields

POSThttps://hermeticor.com/v1/leads/company-fields

Request body

application/json
keystringrequired
labelstringrequired
typestringrequired
text | number | boolean | date | select | url
optionsstring[]
requiredboolean
{
  "key": "string",
  "label": "string",
  "type": "text",
  "options": [
    "string"
  ],
  "required": true
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/leads/company-fields" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"key":"string","label":"string","type":"text","options":["string"],"required":true}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

201 Default Response
Example
{
  "key": "string",
  "label": "string",
  "type": "text",
  "options": [
    "string"
  ],
  "required": true,
  "createdAt": "2024-01-01T00:00:00Z"
}
Schema
keystringrequired
labelstringrequired
typestringrequired
text | number | boolean | date | select | url
optionsstring[]required
requiredbooleanrequired
createdAtstringrequired
4XX Default Response

Same as 4XX · GET /v1/leads/company-fields

5XX Default Response

Same as 4XX · GET /v1/leads/company-fields

DELETEhttps://hermeticor.com/v1/leads/company-fields/{key}

Parameters

keystringpathrequired

Code samples

cURL
curl -X DELETE "https://hermeticor.com/v1/leads/company-fields/{key}" \
  -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/company-fields

5XX Default Response

Same as 4XX · GET /v1/leads/company-fields

PATCHhttps://hermeticor.com/v1/leads/company-fields/{key}

Parameters

keystringpathrequired

Request body

application/json
labelstring
optionsstring[]
requiredboolean
{
  "label": "string",
  "options": [
    "string"
  ],
  "required": true
}

Code samples

cURL
curl -X PATCH "https://hermeticor.com/v1/leads/company-fields/{key}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"label":"string","options":["string"],"required":true}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response

Same as 201 · POST /v1/leads/company-fields

4XX Default Response

Same as 4XX · GET /v1/leads/company-fields

5XX Default Response

Same as 4XX · GET /v1/leads/company-fields

POSThttps://hermeticor.com/v1/leads/companies/bulk-delete

Delete up to 500 companies; do-not-contact blocks on their domains stay

Request body

application/json
idsstring[]required
{
  "ids": [
    "string"
  ]
}

Code samples

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

Responses

200 Default Response
Example
{
  "deleted": 0,
  "failed": [
    {
      "index": 0,
      "id": "string",
      "reason": "string"
    }
  ]
}
Schema
deletedintegerrequired
failedobject[]required
Show child parameters
indexintegerrequired
idstring
reasonstringrequired
4XX Default Response

Same as 4XX · GET /v1/leads/company-fields

5XX Default Response

Same as 4XX · GET /v1/leads/company-fields

POSThttps://hermeticor.com/v1/leads/companies/batch

Create, edit, delete and link companies in one call (up to 500 operations); failures are reported per item

Request body

application/json
createPostV1LeadsCompaniesBody[]
Show child parameters
domainstringrequired
namestring
industrystring
sizeBandstring
countrystring
customFieldsobject
updateobject[]
Show child parameters
namestring
industrystring
sizeBandstring
countrystring
customFieldsobject
idstringrequired
deletestring[]
linkobject[]
Show child parameters
companyIdstringrequired
profileIdstringrequired
primaryboolean
jobTitlestring
rolestring
{
  "create": [
    {
      "domain": "string",
      "name": "string",
      "industry": "string",
      "sizeBand": "string",
      "country": "string",
      "customFields": {}
    }
  ],
  "update": [
    {
      "name": "string",
      "industry": "string",
      "sizeBand": "string",
      "country": "string",
      "customFields": {},
      "id": "string"
    }
  ],
  "delete": [
    "string"
  ],
  "link": [
    {
      "companyId": "string",
      "profileId": "string",
      "primary": true,
      "jobTitle": "string",
      "role": "string"
    }
  ]
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/leads/companies/batch" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"create":[{"domain":"string","name":"string","industry":"string","sizeBand":"string","country":"string","customFields":{}}],"update":[{"name":"string","industry":"string","sizeBand":"string","country":"string","customFields":{},"id":"string"}],"delete":["string"],"link":[{"companyId":"string","profileId":"string","primary":true,"jobTitle":"string","role":"string"}]}'
TypeScript
Python
Go
PHP
Ruby
Java

Responses

200 Default Response
Example
{
  "created": [
    "string"
  ],
  "updated": [
    "string"
  ],
  "linked": 0,
  "deleted": 0,
  "failed": [
    {
      "op": "string",
      "index": 0,
      "id": "string",
      "reason": "string"
    }
  ]
}
Schema
createdstring[]required
updatedstring[]required
linkedintegerrequired
deletedintegerrequired
failedobject[]required
Show child parameters
opstringrequired
indexintegerrequired
idstring
reasonstringrequired
4XX Default Response

Same as 4XX · GET /v1/leads/company-fields

5XX Default Response

Same as 4XX · GET /v1/leads/company-fields

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

Link several contacts at once, with optional link fields

Parameters

idstringpathrequired

Request body

application/json
linksPostV1LeadsCompaniesByIdLinkBody[]required
Show child parameters
profileIdstringrequired
primaryboolean
jobTitlestring
rolestring
{
  "links": [
    {
      "profileId": "string",
      "primary": true,
      "jobTitle": "string",
      "role": "string"
    }
  ]
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/leads/companies/{id}/contacts" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"links":[{"profileId":"string","primary":true,"jobTitle":"string","role":"string"}]}'
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

Same as 4XX · GET /v1/leads/company-fields

5XX Default Response

Same as 4XX · GET /v1/leads/company-fields

Updated