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

Authorizations

X-CB-KEY
string
header
required

CloseBot API Key Authorization

Query Parameters

page
integer<int32>
default:0

The page number.

pageSize
integer<int32>
default:20

The page size.

sourceId
string

The source ID.

leadId
string

The lead ID.

Response

Success

total
integer<int32>
results
object[] | null
page
integer<int32>
pageSize
integer<int32>