API docs

Reference · Deep Search

Company summary and first line

POST /api/v1/deep-search

Reads each business's own website and writes a short summary, why your offer could matter to them (set "What you sell" in the app) and a personal first line. For GB and AU businesses it adds official company-registry facts. Registry data is never used to find or guess emails.

Credits: 0.5 credits per business we write a summary for (you only pay when we write the report). Rows your account already got an answer for in the last 30 days are answered again for free (cached30d).

Body (JSON)

NameTypeRequiredWhat it is
listIdintegerRun on a list you already have (from POST /api/v1/lists or a search) instead of rows.
contactIdsarray of integerWith listId: only these rows (default: all rows of the list). up to 50,000
namestringName of the new list (shown in the app). Default: "API ()".
rowsarray of objectsUp to 10,000 businesses (company + website). up to 10,000
rows[].companystringBusiness name.
rows[].websitestringWebsite (any form: https://acme.com, acme.com/contact, www.acme.com).
rows[].domainstringDomain, if you have it instead of a website.
rows[].firstNamestring
rows[].lastNamestring
rows[].fullNamestringUsed when first and last name are not given separately.
rows[].jobTitlestring
rows[].emailstringThe email to check (verify).
rows[].phonestring
rows[].citystring
rows[].statestring
rows[].countrystringTwo-letter country code, e.g. US, CA, GB.
rows[].addressstringBusiness address. For US businesses it decides which state rules apply.
rows[].categorystring
webhookUrlstringPublic https URL we POST the result to when the job is done (see the webhooks guide).
webhookSecretstringOptional: sign this webhook with your own secret instead of the account signing secret.
waitintegerSeconds to wait for the job to finish before answering (0–30). Handy for Zapier, Make and Clay: small jobs come back done, with results. default 0, 0–30

Example request

Shell
curl -X POST "https://moleman.io/api/v1/deep-search" \
  -H "Authorization: Bearer $MOLEMAN_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"rows":[{"company":"Bright Smile Dental","website":"brightsmiledental.com","city":"Austin","country":"US"}]}'

Example answer

JSON
{
  "jobId": 983,
  "listId": 379,
  "status": "queued",
  "livemode": true,
  "queued": 1,
  "skipped": [],
  "cached30d": 0,
  "maxCreditsHeld": 0.5,
  "pollUrl": "/api/v1/jobs/983"
}

Errors

StatusCodeWhen
401missing_api_keyThe request has no API key.
401invalid_api_keyThe API key is not one of ours (a typo, a cut-off copy, or a key from another account that was deleted).
401revoked_api_keyThe API key was revoked on the API page. Revoking takes effect at once.
429rate_limitedMore than 120 requests in one minute with this key.
500server_errorSomething broke on our side. Nothing was charged for it.
400invalid_requestA parameter is missing, has the wrong type or is out of range. details lists every problem with its path.
400invalid_jsonThe body is not valid JSON.
409idempotency_in_progressA request with the same Idempotency-Key is still running.
422idempotency_key_reusedThe Idempotency-Key was already used in the last 24 hours with a different request.
400no_eligible_rowsNone of the rows can run this action (for example: no website or domain to find an email for, or no email to check).
402insufficient_creditsThe account has fewer credits than this request could use at most. We hold the maximum while the job runs and give back what it does not use.
404not_foundThe job or list does not exist, belongs to another account, or was deleted.
400invalid_webhook_urlThe webhook URL is not a public https address (private networks and other schemes are refused).
403wrong_key_modeA test key asked for something made with a live key, or the other way round. Test and live data never mix.