Skip to main content
POST
Search leads

Authorizations

X-CB-KEY
string
header
required

CloseBot API Key Authorization

Body

The search query input.

totalOnly
boolean | null
sourceOnlyFast
boolean | null
offset
integer<int32> | null

The offset of the search results.

count
integer<int32> | null

The count of the search results.

search
string | null

The search query.

sourceIds
string[] | null

The source IDs.

channels
string[] | null

The channel IDs.

botIds
string[] | null

The bot IDs.

personaIds
string[] | null

The persona IDs.

minimumResponses
integer<int32> | null

The minimum number of responses.

lastMessageDirection
string | null

The last message direction.

followUpScheduled
boolean | null

Whether the follow up is scheduled.

Response

Success

leads
object[] | null
total
integer<int32>