leads

Embed

<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/companies/import-mapped

Import parsed CSV rows with a column mapping (built-in and custom company fields); existing domains are skipped or updated

Request body

application/json

rowsobject[]required

mappingobjectrequired

onExistingstring

skip | update = skip

{
  "rows": [
    {}
  ],
  "mapping": {},
  "onExisting": "skip"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/leads/companies/import-mapped" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"rows":[{}],"mapping":{},"onExisting":"skip"}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "imported": 0,
  "created": 0,
  "updated": 0,
  "skipped": [
    {
      "row": 0,
      "domain": "string",
      "reason": "string"
    }
  ]
}

Schema

importedintegerrequired

createdintegerrequired

updatedintegerrequired

skippedSkippedItem2[]required

Show child parameters

rowintegerrequired

domainstringrequired

reasonstringrequired

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/companies/import-mapped

GEThttps://hermeticor.com/v1/leads/companies/export

Every company as CSV, with score and custom fields

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/leads/companies/export" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "filename": "string",
  "csv": "string",
  "rows": 0,
  "truncated": true
}

Schema

filenamestringrequired

csvstringrequired

rowsintegerrequired

truncatedbooleanrequired

4XX Default Response

Same as 4XX · POST /v1/leads/companies/import-mapped

5XX Default Response

Same as 4XX · POST /v1/leads/companies/import-mapped

GEThttps://hermeticor.com/v1/leads/companies/search

Companies whose name or domain starts with q

Parameters

qstringqueryrequired

limitintegerquery

= 10

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/leads/companies/search?q=<q>" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "domain": "string",
      "suppressed": true
    }
  ]
}

Schema

itemsobject[]required

Show child parameters

idstringrequired

namestringrequired

domainstringrequired

suppressedbooleanrequired

4XX Default Response

Same as 4XX · POST /v1/leads/companies/import-mapped

5XX Default Response

Same as 4XX · POST /v1/leads/companies/import-mapped

GEThttps://hermeticor.com/v1/leads/companies/{id}/score

Account score plus the roll-up of linked contacts' scores (profile attribute `key`)

Parameters

keystringquery

= score

idstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/leads/companies/{id}/score" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "account": 0,
  "total": 0,
  "contacts": {
    "key": "string",
    "sum": 0,
    "average": 0,
    "max": 0,
    "scored": 0,
    "linked": 0
  }
}

Schema

accountintegerrequired

totalnumberrequired

contactsobjectrequired

Show child parameters

keystringrequired

sumnumberrequired

averagenumberrequired

maxnumberrequired

scoredintegerrequired

linkedintegerrequired

4XX Default Response

Same as 4XX · POST /v1/leads/companies/import-mapped

5XX Default Response

Same as 4XX · POST /v1/leads/companies/import-mapped

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

Add (or with a negative delta, take) account score points

Parameters

idstringpathrequired

Request body

application/json

deltaintegerrequired

{
  "delta": 0
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/leads/companies/{id}/score" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"delta":0}'

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

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

4XX Default Response

Same as 4XX · POST /v1/leads/companies/import-mapped

5XX Default Response

Same as 4XX · POST /v1/leads/companies/import-mapped

GEThttps://hermeticor.com/v1/leads/companies/{id}/files

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/leads/companies/{id}/files" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "filename": "string",
      "contentType": "string",
      "size": 0,
      "uploadedBy": "string",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem239[]required

Show child parameters

idstringrequired

filenamestringrequired

contentTypestringrequired

sizeintegerrequired

uploadedBystringrequired

createdAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/leads/companies/import-mapped

5XX Default Response

Same as 4XX · POST /v1/leads/companies/import-mapped

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

Upload a file (multipart field "file": PDF, image, text, CSV, Office or ZIP, up to 25 MB)

Parameters

idstringpathrequired

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/leads/companies/{id}/files" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "filename": "string",
  "contentType": "string",
  "size": 0,
  "uploadedBy": "string",
  "createdAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

filenamestringrequired

contentTypestringrequired

sizeintegerrequired

uploadedBystringrequired

createdAtstringrequired

4XX Default Response

Same as 4XX · POST /v1/leads/companies/import-mapped

5XX Default Response

Same as 4XX · POST /v1/leads/companies/import-mapped

GEThttps://hermeticor.com/v1/leads/companies/{id}/files/{fileId}/url

A download link valid for five minutes

Parameters

idstringpathrequired

fileIdstringpathrequired

Code samples

cURL

curl -X GET "https://hermeticor.com/v1/leads/companies/{id}/files/{fileId}/url" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "url": "string"
}

Schema

urlstringrequired

4XX Default Response

Same as 4XX · POST /v1/leads/companies/import-mapped

5XX Default Response

Same as 4XX · POST /v1/leads/companies/import-mapped

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

Parameters

idstringpathrequired

fileIdstringpathrequired

Code samples

cURL

curl -X DELETE "https://hermeticor.com/v1/leads/companies/{id}/files/{fileId}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "ok": true
}

Schema

okbooleanrequired

true

4XX Default Response

Same as 4XX · POST /v1/leads/companies/import-mapped

5XX Default Response

Same as 4XX · POST /v1/leads/companies/import-mapped

Updated Nov 8, 2026

Was this page helpful?