Skip to main content
GET
/
lead
/
{leadId}
Get a lead
curl --request GET \
  --url https://api.closebot.com/lead/{leadId} \
  --header 'X-CB-KEY: <api-key>'
{
  "id": "<string>",
  "name": "<string>",
  "contactId": "<string>",
  "lastMessageTime": "2023-11-07T05:31:56Z",
  "lastMessage": "<string>",
  "lastMessageDirection": "<string>",
  "lastMessageBotId": "<string>",
  "mostRecentFailureReason": "<string>",
  "mimicSourceId": "<string>",
  "starred": true,
  "unread": true,
  "source": {
    "name": "<string>",
    "id": "<string>"
  },
  "wontRespondUntil": "2023-11-07T05:31:56Z",
  "tags": [
    "<string>"
  ],
  "fields": [
    {
      "field": "<string>",
      "name": "<string>",
      "value": "<string>",
      "aiProduced": true
    }
  ],
  "instances": [
    {
      "botId": "<string>",
      "botVersion": "<string>",
      "followUpTimezoneKind": "<string>",
      "followUpTimezone": "<string>",
      "followUpTime": "2023-11-07T05:31:56Z",
      "isSmartFollowUpTime": true,
      "scheduleRespondTime": "2023-11-07T05:31:56Z"
    }
  ]
}

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