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

Request body

application/json

emailsstring[]required

maxBounceRatenumber

= 0.05

{
  "emails": [
    "string"
  ],
  "maxBounceRate": 0.05
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/leads/clean" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"emails":["string"],"maxBounceRate":0.05}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "kind": "clean",
  "status": "queued",
  "total": 0,
  "processed": 0,
  "summary": {},
  "error": "string",
  "createdAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

kindstringrequired

clean | enrich

statusstringrequired

queued | running | done | failed

totalintegerrequired

processedintegerrequired

summaryobjectrequired

errorstringrequired

createdAtstringrequired

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

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

Request body

application/json

leadIdsstring[]required

waterfallIdstring

{
  "leadIds": [
    "string"
  ],
  "waterfallId": "string"
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/leads/enrich" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"leadIds":["string"],"waterfallId":"string"}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Same as 201 · POST /v1/leads/clean

4XX Default Response

Same as 4XX · POST /v1/leads/clean

5XX Default Response

Same as 4XX · POST /v1/leads/clean

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

Parameters

limitintegerquery

= 50

cursorstringquery

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "kind": "clean",
      "status": "queued",
      "total": 0,
      "processed": 0,
      "summary": {},
      "error": "string",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsPostV1LeadsCleanResponse[]required

Show child parameters

idstringrequired

kindstringrequired

clean | enrich

statusstringrequired

queued | running | done | failed

totalintegerrequired

processedintegerrequired

summaryobjectrequired

errorstringrequired

createdAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/leads/clean

5XX Default Response

Same as 4XX · POST /v1/leads/clean

GEThttps://hermeticor.com/v1/leads/jobs/{id}

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "id": "string",
  "kind": "clean",
  "status": "queued",
  "total": 0,
  "processed": 0,
  "summary": {},
  "error": "string",
  "createdAt": "2024-01-01T00:00:00Z",
  "rows": [
    {
      "email": "string",
      "status": "valid",
      "risk": 0,
      "flags": [
        "string"
      ]
    }
  ]
}

Schema

idstringrequired

kindstringrequired

clean | enrich

statusstringrequired

queued | running | done | failed

totalintegerrequired

processedintegerrequired

summaryobjectrequired

errorstringrequired

createdAtstringrequired

rowsobject[]required

Show child parameters

emailstringrequired

statusstringrequired

riskintegerrequired

flagsstring[]required

4XX Default Response

Same as 4XX · POST /v1/leads/clean

5XX Default Response

Same as 4XX · POST /v1/leads/clean

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

The criteria a lead search accepts (every one takes a list of values)

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/filters" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "key": "string",
      "label": "string",
      "type": "list",
      "hint": "string"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsobject[]required

Show child parameters

keystringrequired

labelstringrequired

typestringrequired

list

hintstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/leads/clean

5XX Default Response

Same as 4XX · POST /v1/leads/clean

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

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/waterfalls" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY"

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Example

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "providerIds": [
        "string"
      ],
      "fields": [
        "email"
      ],
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}

Schema

itemsItemsItem118[]required

Show child parameters

idstringrequired

namestringrequired

providerIdsstring[]required

fieldsstring[]required

createdAtstringrequired

nextCursorstringrequired

4XX Default Response

Same as 4XX · POST /v1/leads/clean

5XX Default Response

Same as 4XX · POST /v1/leads/clean

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

Request body

application/json

namestringrequired

providerIdsstring[]required

fieldsstring[]

= ["email","phone","title","linkedinUrl"]

{
  "name": "string",
  "providerIds": [
    "string"
  ],
  "fields": [
    "email",
    "phone",
    "title",
    "linkedinUrl"
  ]
}

Code samples

cURL

curl -X POST "https://hermeticor.com/v1/leads/waterfalls" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","providerIds":["string"],"fields":["email","phone","title","linkedinUrl"]}'

TypeScript

Python

PHP

Ruby

Java

Responses

201 Default Response

Example

{
  "id": "string",
  "name": "string",
  "providerIds": [
    "string"
  ],
  "fields": [
    "email"
  ],
  "createdAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

namestringrequired

providerIdsstring[]required

fieldsstring[]required

createdAtstringrequired

4XX Default Response

Same as 4XX · POST /v1/leads/clean

5XX Default Response

Same as 4XX · POST /v1/leads/clean

GEThttps://hermeticor.com/v1/leads/waterfalls/{id}

Parameters

idstringpathrequired

Code samples

cURL

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

TypeScript

Python

PHP

Ruby

Java

Responses

200 Default Response

Same as 201 · POST /v1/leads/waterfalls

4XX Default Response

Same as 4XX · POST /v1/leads/clean

5XX Default Response

Same as 4XX · POST /v1/leads/clean

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

Parameters

idstringpathrequired

Code samples

cURL

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

5XX Default Response

Same as 4XX · POST /v1/leads/clean

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

Parameters

idstringpathrequired

Request body

application/json

namestring

providerIdsstring[]

fieldsstring[]

{
  "name": "string",
  "providerIds": [
    "string"
  ],
  "fields": [
    "email"
  ]
}

Code samples

cURL

curl -X PATCH "https://hermeticor.com/v1/leads/waterfalls/{id}" \
  -H "Authorization: Bearer $HERMETICOR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","providerIds":["string"],"fields":["email"]}'

TypeScript

Python

PHP

Ruby

Java