Skip to content
LeadSonar LeadSonar Docs

Reveal leads

POST
/api/v1/leads/reveal

Cost: 1 credit per lead not already revealed

Runs the app’s own reveal: one transaction, the same already-revealed dedup, the same ledger entries. All-or-nothing — an account that cannot pay for the whole batch reveals none of it.

Try it

curl https://app.leadsonar.io/api/v1/leads/reveal \
  -H "X-API-Key: $LS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "leadIds": ["3f1c2a90-0000-4000-8000-000000000001"]
  }'

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
object
leadIds
required

Lead ids from /leads/browse. A malformed id rejects the whole batch — you are billed per row and must know what you paid for.

Array<string>
<= 100000 items
Example
{
  "leadIds": ["3f1c2a90-0000-4000-8000-000000000001"]
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Revealed rows and what they cost

object
revealed

Full rows: real email, domain and LinkedIn URL.

Array<object>
object
credits_charged

REVEAL_COST per NEW lead. Leads this account already revealed are returned again and charged nothing.

integer
new_reveals
integer
already_revealed
integer
Example
{
  "revealed": [
    {
      "id": "3f1c2a90-0000-4000-8000-000000000001",
      "firstName": "Jordan",
      "lastName": "Reyes",
      "fullName": "Jordan Reyes",
      "email": "jordan.reyes@example-software.com",
      "emailStatus": "unknown",
      "phone": "+15125550110",
      "linkedinUrl": "linkedin.com/in/jordanreyes",
      "companyName": "Example Software Inc.",
      "companyDomain": "example-software.com",
      "jobTitle": "Head Of Sales Amer",
      "seniority": "",
      "department": "",
      "country": null,
      "countryCode": "US",
      "state": "TX",
      "city": "Austin",
      "companySize": "101 to 250",
      "companyRevenue": null,
      "companyFounded": null,
      "companyLinkedin": null,
      "industryName": null,
      "categoryName": null,
      "enrichmentStatus": "raw",
      "confidenceScore": 0
    }
  ],
  "credits_charged": 1,
  "new_reveals": 1,
  "already_revealed": 0
}

400

Section titled “400 ”

LEAD_IDS_REQUIRED, TOO_MANY_LEADS or BAD_ID

object
error
required

Human-readable error message

string
message

Additional details

string
Example
{
  "error": "leadIds is required — the ids of the leads to reveal, from /leads/browse",
  "code": "LEAD_IDS_REQUIRED"
}

402

Section titled “402 ”

INSUFFICIENT_CREDITS — nothing was revealed or charged

object
error
required

Human-readable error message

string
message

Additional details

string