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

Newest notes across contacts and companies, newest first; page with `before`

Parameters

limitintegerquery
= 50
beforestringquery

Code samples

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

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "resource": "contact",
      "resourceId": "string",
      "body": "string",
      "authorId": "string",
      "at": "2024-01-01T00:00:00Z"
    }
  ],
  "nextBefore": "string"
}
Schema
itemsobject[]required
Show child parameters
idstringrequired
resourcestringrequired
contact | company
resourceIdstringrequired
bodystringrequired
authorIdstringrequired
atstringrequired
nextBeforestringrequired
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/notes

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

Parameters

limitintegerquery
= 50
cursorstringquery
idstringpathrequired

Code samples

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

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "companyId": "string",
      "body": "string",
      "authorId": "string",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem153[]required
Show child parameters
idstringrequired
companyIdstringrequired
bodystringrequired
authorIdstringrequired
createdAtstringrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /v1/notes

5XX Default Response

Same as 4XX · GET /v1/notes

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

Parameters

idstringpathrequired

Request body

application/json
bodystringrequired
{
  "body": "string"
}

Code samples

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

Responses

201 Default Response
Example
{
  "id": "string",
  "companyId": "string",
  "body": "string",
  "authorId": "string",
  "createdAt": "2024-01-01T00:00:00Z"
}
Schema
idstringrequired
companyIdstringrequired
bodystringrequired
authorIdstringrequired
createdAtstringrequired
4XX Default Response

Same as 4XX · GET /v1/notes

5XX Default Response

Same as 4XX · GET /v1/notes

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

Parameters

idstringpathrequired
noteIdstringpathrequired

Code samples

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

5XX Default Response

Same as 4XX · GET /v1/notes

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

Edit a company note

Parameters

idstringpathrequired
noteIdstringpathrequired

Request body

application/json
bodystringrequired
{
  "body": "string"
}

Code samples

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

Responses

200 Default Response

Same as 201 · POST /v1/leads/companies/{id}/notes

4XX Default Response

Same as 4XX · GET /v1/notes

5XX Default Response

Same as 4XX · GET /v1/notes

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

Merge duplicate companies into this one (contacts, notes and list memberships move; suppressions are untouched)

Parameters

idstringpathrequired

Request body

application/json
mergeIdsstring[]required
{
  "mergeIds": [
    "string"
  ]
}

Code samples

cURL
curl -X POST "https://hermeticor.com/v1/leads/companies/{id}/merge" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"mergeIds":["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/notes

5XX Default Response

Same as 4XX · GET /v1/notes

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

Account stage and owner; written through to the outbound account so do-not-contact gates enrollment

Parameters

idstringpathrequired

Request body

application/json
stagestring
new | engaged | opportunity | customer | not_a_fit | do_not_contact
ownerUserIdstring
{
  "stage": "new",
  "ownerUserId": "string"
}

Code samples

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

Responses

200 Default Response

Same as 200 · POST /v1/leads/companies/{id}/merge

4XX Default Response

Same as 4XX · GET /v1/notes

5XX Default Response

Same as 4XX · GET /v1/notes

POSThttps://hermeticor.com/v1/leads/companies/unify-accounts

Fold outbound accounts into lead companies by domain, keeping their status, owner and website

Code samples

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

Responses

200 Default Response
Example
{
  "linked": 0,
  "created": 0
}
Schema
linkedintegerrequired
createdintegerrequired
4XX Default Response

Same as 4XX · GET /v1/notes

5XX Default Response

Same as 4XX · GET /v1/notes

GEThttps://hermeticor.com/v1/leads/company-lists

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

Responses

200 Default Response
Example
{
  "items": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "companyCount": 0,
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}
Schema
itemsItemsItem154[]required
Show child parameters
idstringrequired
namestringrequired
descriptionstringrequired
companyCountintegerrequired
createdAtstringrequired
nextCursorstringrequired
4XX Default Response

Same as 4XX · GET /v1/notes

5XX Default Response

Same as 4XX · GET /v1/notes

Updated