PlatformDocs

Lead details

Open one lead to see the person, their company, how well they fit and an AI summary of their visits.

Read one lead in full from your own code: the person, the company, every page visit, an AI summary, and the other people at their company. The leadId is the _id of a row from GET /v3/leads. Authenticated with ?privateKey=YOUR_KEY (see Authentication).

GET/v3/leads/{leadId}Get lead details
GET/v3/leads/{leadId}/summaryAI visit summary for a lead
PUT/v3/leads/{leadId}/notesUpdate lead notes
GET/v3/leads/{leadId}/company-peopleGet people at the lead's company
GET
Try:
Parameters
Lead IdLead id (the _id of a row returned by get_leads).
curl -X GET "https://rest-dash.revealid.xyz/v3/leads/6530c1d2e3f4a5b6c7d8e9f2?privateKey=YOUR_KEY"
Response
Press Send request to try it with sample data.

What each field accepts

FieldTypeLimits and formatAccepted values
leadId*string—any

Use case: Show the visit in your CRM

GET /v3/leads/{leadId} returns exactPerson (name, emails, phone, position, LinkedIn, or null when only the company is known), exactPersonType (Exact Visitor or Suggested Contact), the company, pageVisits[] with time spent per page, and summary (total visits, last visit, referrer).

Use case: Get the summary of one lead

GET /v3/leads/{leadId}/summary returns aISummary: about 50 words on what they looked at, ending with Ready to Buy, Research or Just Browsing. It is generated on each call, so cache it if you show it often.

Use case: Find the buyer at the company

GET /v3/leads/{leadId}/company-people?department=Sales Department lists other people at the lead's company (name, title, department, seniority, LinkedIn), free. PUT /v3/leads/{leadId}/notes replaces the lead's notes text.

On this page