Skip to main content
GET
Get a lead

Authorizations

X-CB-KEY
string
header
required

CloseBot API Key Authorization

Path Parameters

leadId
string
required

The ID of the lead to get.

Query Parameters

includeExternal
boolean
default:false

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

Response

Success

id
string | null
name
string | null
contactId
string | null
lastMessageTime
string<date-time> | null
lastMessage
string | null
lastMessageDirection
string | null
lastMessageBotId
string | null
mostRecentFailureReason
string | null
mimicSourceId
string | null
starred
boolean
unread
boolean
source
object
wontRespondUntil
string<date-time> | null
tags
string[] | null
fields
object[] | null
instances
object[] | null