Sign in

v1

latestOpenAPI 3.0.12026-07-26132140134.9 KB
Lead

Get a lead

get/lead/{leadId}

Path parameters

leadIdstring required

The ID of the lead to get.

Query parameters

includeExternalboolean

Include external fields of the lead in the result (fields from the CRM).

Response

Success

idstring nullable
namestring nullable
contactIdstring nullable
lastMessageTimestring date-time nullable
lastMessagestring nullable
lastMessageDirectionstring nullable
lastMessageBotIdstring nullable
mostRecentFailureReasonstring nullable
mimicSourceIdstring nullable
starredboolean
unreadboolean
wontRespondUntilstring date-time nullable
tagsstring[] nullable