For a given portal, return prospects in JSON format.
By default, the API will return the most recent 20 prospects to you, but you can access other prospects using the offset parameters found below.
| 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. |
| Optional Parameters | How to use | Description |
|---|---|---|
| Time Offset | &timeOffset=X - Used in the request URL | If specified, start the prospect timeline at the given point in time, meaning only prospects from the time you specify to the current time will be returned. This timestamp, as with all HubSpot timestamps is milliseconds since the Unix epoch, UTC, so you can use a web site like http://epochconverter.com when testing. |
| Organization Offset | &orgOffset=X - Used in the request URL | If specified, start the prospect timeline at the given organization. The organization name should match one of the organizations returned in previous called to this method, the typeahead or search methods. |
Example URL: https://api.hubapi.com/prospects/v1/timeline?access_token=demooooo-oooo-oooo-oooo-oooooooooooo
Example JSON response. For example purposes, we're only displaying 3 out of the 20 prospects that would be returned to the example URL you see here:
Please note the organization field in the below response. This field is used as the input to subsequent search and filtering methods, as documented in other Prospects API methods.
{
"prospects": [
{
"slug": "private-ip-address-lan",
"organization": "PRIVATE IP ADDRESS LAN",
"page-views": 250,
"visitors": 209,
"timestamp": 1323307908,
"city": "",
"region": "",
"country": "",
"url": "",
"leads": 209,
"longitude": 0,
"latitude": 0,
"ip-address": "10.101.61.104",
"touches": []
},
{
"slug": "business-financial-services",
"organization": "BUSINESS FINANCIAL SERVICES",
"page-views": 26,
"visitors": 2,
"timestamp": 1323209408,
"city": "POMPANO BEACH",
"region": "FLORIDA",
"country": "UNITED STATES",
"url": "BUSINESSFINANCIALSERVICES.COM",
"leads": 0,
"longitude": -80.12476,
"latitude": 26.23786,
"ip-address": "12.132.139.154",
"touches": [
{
"domain": "docs.hubapi.com",
"child-id": "167755"
}
]
},
{
"slug": "boathouse-group-inc",
"organization": "BOATHOUSE GROUP INC",
"page-views": 1,
"visitors": 1,
"timestamp": 1323200318,
"city": "WALTHAM",
"region": "MASSACHUSETTS",
"country": "UNITED STATES",
"url": "",
"leads": 0,
"longitude": -71.23561,
"latitude": 42.376484,
"ip-address": "64.119.152.146",
"touches": [
{
"domain": "docs.hubapi.com",
"child-id": "167755"
}
]
}
]
}
HTTP Methods:
GET
Response Format:
json
Requires Authentication?
Yes
Rate Limited?
Headers