Skip to main content
POST
Count matching leads

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

A search request.

Both query shapes are accepted on every request and the record type picks which one is read, so the client can keep a draft of each while the user toggles between people and companies without losing what they typed.

record_type
enum<string>
required

Which side of the lead database a search runs against.

Available options:
people,
companies
companies
CompanyQuerySchema · object | null

Filters for a company search.

people
PeopleQuerySchema · object | null

Filters for a people search.

Response

Successful Response

How many leads matched, and the most one search may land.

total
integer
required