For a given portal, return information about prospects in JSON format, based on a partial or typeahead search.
| Required Parameters | How to use | Description |
|---|---|---|
| HubSpot OAuth Access Token | access_token=X - Used in the request URL | The HubSpot API key for the portal that you're making the call for. |
| Typeahead Search Query | &q=X - Used in the request URL | Your typeahead search query. |
| Optional Parameters | How to use | Description |
|---|---|---|
| None | None | No optional parameters for this method. |
Example URL: https://api.hubapi.com/prospects/v1/typeahead?access_token=demooooo-oooo-oooo-oooo-oooooooooooo&q=prn
Example JSON response:
{
"COUNTRY": {
"values": [],
"total": 0
},
"CITY": {
"values": [],
"total": 0
},
"REGION": {
"values": [],
"total": 0
},
"ORGANIZATION": {
"values": [
"prnewswire"
],
"total": 1
}
}
HTTP Methods:
GET
Response Format:
json
Requires Authentication?
Yes
Rate Limited?
Headers