There's a new version of the HubSpot API

Check out the new API
View Beta Docs

We're also working on a new documentation website, you're invited to check it out and give us your feedback.

Get recently added contacts from a list

Last updated May 15, 2023

GET /contacts/v1/lists/:list_id/contacts/recent

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing

Required Scope:

crm.objects.contacts.read

For a given HubID and a given list, return contacts that have been recently added to that list, starting with the most recently added contact and pageing backwards. A paginated list of contacts will be returned to you, with a maximum of 100 contacts per page, as specified by the "count" parameter.

Please Note There are 3 fields here to pay close attention to: the "has-more" field that will let you know whether there are more contacts that you can pull from this portal, and the "vid-offset" and "time-offset" fields which will let you know where you are in the list of contacts. You can then use the "vid-offset" and "time-offset" fields in the "vidOffset" and "timeOffset" parameters described below.

Required Parameters How to use Description
OAuth access token or private app access token Authorization: Bearer {token} header Used to authenticate the request. Please see this page for more details about authentication.
List ID Used in the request URL Unique identifier for the list that you're looking for.
Optional Parameters How to use Description
Count &count=X - Used in the request URL This parameter lets you specify the amount of contacts to return in your API call. The default for this parameter (if it isn't specified) is 20 contacts. The maximum amount of contacts you can have returned to you via this parameter is 100.
Time Offset &timeOffset=X - Used in the request URL Used in conjunction with the vidOffset paramter to page through the recent contacts. Every call to this endpoint will return a time-offset value. This value is used in the timeOffset parameter of the next call to get the next page of contacts.
Contact Offset &vidOffset=X - Used in the request URL Used in conjunction with the timeOffset paramter to page through the recent contacts. Every call to this endpoint will return a vid-offset value. This value is used in the vidOffset parameter of the next call to get the next page of contacts.
Property &property=X - Used in the request URL If you include the "property" parameter, then the properties in the "contact" object in the returned data will only include the property or properties that you request.
Property Mode &propertyMode=x One of “value_only” or “value_and_history” to specify if the current value for a property should be fetched, or the value and all the historical values for that property. Default is “value_only”.
Form Submission Mode &formSubmissionMode=x One of “all”, “none”, “newest”, “oldest” to specify which form submissions should be fetched. Default is “newest”.
List Memberships &showListMemberships=x Boolean "true" or "false" to indicate whether current list memberships should be fetched for the contact. Default is false.

Example URL is here - note that the list ID is "1":
https://api.hubapi.com/contacts/v1/lists/1/contacts/recent

About

Jobs

Learn Inbound

Support

Locations

HubSpot, Inc.
25 First Street, 2nd Floor
Cambridge, MA 02141
European Headquarters
Ground Floor, Two Dockland Central
Guild Street, Dublin 1
Asia/Pacific Office
20 Hunter St, Level 7
Sydney NSW 2000
View our other locations
Example URL: https://api.hubapi.com/contacts/v1/lists/226468/contacts/recent Example response: { "contacts": [ { "addedAt": 1479505144499, "vid": 3057124, "canonical-vid": 3057124, "merged-vids": [ ], "portal-id": 62515, "is-contact": true, "profile-token": "AO_T-mOgj2A6el_vSMW93xjaN_1uO4Qb4p2n-SiJ1Qu-0hPqyny7hXw8GmAL-J7H2Jcjqu5uo4i-AYTiROr27j3HxSj5i38cU3q7FXInxPCQym5t7w563SfnpwjzQOQIMMj4-2CCi_NM", "profile-url": "https://app.hubspot.com/contacts/62515/lists/public/contact/_AO_T-mOgj2A6el_vSMW93xjaN_1uO4Qb4p2n-SiJ1Qu-0hPqyny7hXw8GmAL-J7H2Jcjqu5uo4i-AYTiROr27j3HxSj5i38cU3q7FXInxPCQym5t7w563SfnpwjzQOQIMMj4-2CCi_NM/", "properties": { "lastmodifieddate": { "value": "1479505114122" } }, "form-submissions": [ ], "identity-profiles": [ { "vid": 3057124, "saved-at-timestamp": 1479505110714, "deleted-changed-timestamp": 0, "identities": [ { "type": "EMAIL", "value": "test2@hubspot.com", "timestamp": 1479505110679 }, { "type": "LEAD_GUID", "value": "4ac59265-c366-48c6-95dc-001e8ff181b0", "timestamp": 1479505110710 } ] } ], "merge-audits": [ ] }, { "addedAt": 1479505144498, "vid": 3006574, "canonical-vid": 3006574, "merged-vids": [ ], "portal-id": 62515, "is-contact": true, "profile-token": "AO_T-mOMnOv_jso-E0jKsjCh9Q5tfdCB-2McgYPne3Mp8zZ6zCrCC7Vt35Y4fNLq4_yFi-Ob_ynUf4VFz72NueDg7qtn_0xXkM5_HUa6RmpxHx4chGYy5cL6LuaLenrfyJr0_vcPMU1-", "profile-url": "https://app.hubspot.com/contacts/62515/lists/public/contact/_AO_T-mOMnOv_jso-E0jKsjCh9Q5tfdCB-2McgYPne3Mp8zZ6zCrCC7Vt35Y4fNLq4_yFi-Ob_ynUf4VFz72NueDg7qtn_0xXkM5_HUa6RmpxHx4chGYy5cL6LuaLenrfyJr0_vcPMU1-/", "properties": { "firstname": { "value": "Codey" }, "lastmodifieddate": { "value": "1478203760401" }, "company": { "value": "HubSpot" }, "lastname": { "value": "Huang" } }, "form-submissions": [ ], "identity-profiles": [ { "vid": 3006574, "saved-at-timestamp": 1477944287758, "deleted-changed-timestamp": 0, "identities": [ { "type": "EMAIL", "value": "testingapis@hubspot.com", "timestamp": 1477944287611 }, { "type": "LEAD_GUID", "value": "5ba8abce-3835-4b11-a1e6-3d1bcb01a431", "timestamp": 1477944287754 } ] } ], "merge-audits": [ ] } ], "has-more": false, "vid-offset": 3006574, "time-offset": 1479505144498 }