Account

Get scrape defaults

Read the filters and lead count the account's new orders open on.

GETapi.leadity.io/v1/account/scrape-defaults

Scope readMCP tool get_scrape_defaults

Answers the account's usual order: the filters and the lead count the Leadity app opens a new scrape on, as the customer saved them. Asked to run the usual scrape, pass filters to estimate_scrape and create_scrape as they are. Keys cannot change them.

Example request

curl "https://api.leadity.io/v1/account/scrape-defaults" \
  -H "Authorization: Bearer $LEADITY_API_KEY"

Example response

{
  "filters": {
    "phoneTypeFilter": "mobile",
    "websitePresence": "any",
    "findOwner": false,
    "emailFinder": "off",
    "nicheMatch": true,
    "minGoogleReviews": 0
  },
  "targetLeads": 1000
}

Headers

Authorizationstringrequired

Bearer, a space, then an API key: Bearer lk_api_... An MCP key is refused here with wrong_key_kind.

Response

filtersobjectrequired

The saved filters, in the shape an order's filters object takes, so they pass to estimate_scrape and create_scrape unchanged. A filter that is off is absent or at its free value. The delivery filters, each independent of the others. app-api validates this object, so a bad value answers invalid_body. Today: websitePresence (required: any, has or none); phoneTypeFilter (off, with_phone, mobile, landline or voip); findOwner (true delivers only businesses with a confirmed owner name); emailFinder (off, require or require_verified, which deliver only businesses whose own site publishes an address, verified for the second; stepped down to off when websitePresence is none); nicheMatch (true delivers only businesses whose own Google main category is an ordered niche); minGoogleReviews (0 or one of the floors get_pricing lists); reviews ({ minReviews, maxReviews }: walk each business's Google reviews, charged per review). Absent fields are off. The full and current list, with prices, is on the filters page of the Leadity docs; get_scrape_defaults answers the account's own usual set.

targetLeadsintegerrequired

The lead count a new order opens at.

Errors

Every refusal answers { error, message } with the status below. The full list is on the Errors page.

Code	Status	Meaning	Extra fields
unauthorized	401	The API key is missing, malformed, revoked or expired.	-
wrong_key_kind	401	This key opens the other surface: an API key works on the HTTP API, an MCP key on the MCP server.	-
account_suspended	403	The account is suspended.	-
email_not_verified	403	The account's email address is not verified yet.	-
rate_limited	429	Too many requests. Wait for the Retry-After seconds and try again.	`retryAfterSeconds`: The seconds to wait, the same number as the Retry-After header.
try_again	503	Leadity could not answer just now. Retry in a moment, with the same Idempotency-Key on a spending call.	`retryAfterSeconds`: When a request with this Idempotency-Key is still being processed: the seconds to wait before retrying with the same key, as the Retry-After header says.
internal_error	500	Something failed on our side. Nothing was charged twice.	`body`: On the MCP server, when Leadity answered in a shape the tool does not publish: that answer as it came.