Skip to main content
GET
List leads

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

OK

Paginated lead list plus a scope-wide starred count, so the sidebar's Priority badge can show a true total instead of a loaded-page proxy.

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

Count of leads with a note @-mentioning the caller, scope-wide.