Skip to content

Search Coach Prospects

GET
/sales-coach/prospects/search

Find the prospect the AI will play.

Paginated, because an audience is routinely larger than a picker: offset plus limit rather than a page number, matching the app.

Authorizations

Parameters

Query Parameters

audience_id
required

Audience to search within.

string

Audience to search within.

q

Free text over the prospect’s name and company.

string
""

Free text over the prospect’s name and company.

limit
integer
default: 50 >= 1 <= 200
offset
integer

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for a LIST result, so a bare list keeps its shape.

object
items
Array
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string