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 all contacts

Last updated May 12, 2023

GET /contacts/v1/lists/all/contacts/all

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing & CRM

Required Scope:

crm.objects.contacts.read

For a given account, return all contacts that have been created in the account.

A paginated list of contacts will be returned to you, with a maximum of 100 contacts per page.

Note: There are 2 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 account, and the "vid-offset" field which will let you know where you are in the list of contacts. You can then use the "vid-offset" field in the "vidOffset" parameter 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.
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.
Contact Offset &vidOffset=X - Used in the request URL Used to page through the 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
May be included multiple times.		 By default, only a few standard properties will be included in the response data. If you include the 'property' parameter, then you will instead get the specified property in the response. This parameter may be included multiple times to specify multiple properties. NOTE: Contacts only store data for properties with a value, so records with no value for a property will not include that property, even if the property is specified in the request URL.
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:  https://api.hubapi.com/contacts/v1/lists/all/contacts/all

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 GET URL: https://api.hubapi.com/contacts/v1/lists/all/contacts/all Example response: { "contacts": [ { "addedAt": 1390574181854, "vid": 204727, "canonical-vid": 204727, "merged-vids": [ ], "portal-id": 62515, "is-contact": true, "properties": { "firstname": { "value": "Bob" }, "lastmodifieddate": { "value": "1483461406481" }, "company": { "value": "" }, "lastname": { "value": "Record" } }, "form-submissions": [ ], "identity-profiles": [ { "vid": 204727, "saved-at-timestamp": 1476768116149, "deleted-changed-timestamp": 0, "identities": [ { "type": "LEAD_GUID", "value": "f9d728f1-dff1-49b0-9caa-247dbdf5b8b7", "timestamp": 1390574181878 }, { "type": "EMAIL", "value": "mgnew-email@hubspot.com", "timestamp": 1476768116137 } ] } ], "merge-audits": [ ] }, { "addedAt": 1392643921079, "vid": 207303, "canonical-vid": 207303, "merged-vids": [ ], "portal-id": 62515, "is-contact": true, "properties": { "firstname": { "value": "Ff_FirstName_0" }, "lastmodifieddate": { "value": "1479148429488" }, "lastname": { "value": "Ff_LastName_0" } }, "form-submissions": [ ], "identity-profiles": [ { "vid": 207303, "saved-at-timestamp": 1392643921090, "deleted-changed-timestamp": 0, "identities": [ { "type": "EMAIL", "value": "email_0be34aebe5@abctest.com", "timestamp": 1392643921079 }, { "type": "LEAD_GUID", "value": "058378c6-9513-43e1-a13a-43a98d47aa22", "timestamp": 1392643921082 } ] } ], "merge-audits": [ ] } ], "has-more": true, "vid-offset": 207303 }
# This example displays how to get all contacts from a HubID and paginate through them using the 'offset' parameter. # The end result is a python list containing all parsed contacts. import requests import json import urllib max_results = 500 count = 5 contact_list = [] property_list = [] get_all_contacts_url = "https://api.hubapi.com/contacts/v1/lists/all/contacts/all" parameter_dict = {'count': count} headers = {} # Paginate your request using offset has_more = True while has_more: parameters = urllib.urlencode(parameter_dict) get_url = get_all_contacts_url + parameters r = requests.get(url= get_url, headers = headers) response_dict = json.loads(r.text) has_more = response_dict['has-more'] contact_list.extend(response_dict['contacts']) parameter_dict['vidOffset']= response_dict['vid-offset'] if len(contact_list) >= max_results: # Exit pagination, based on whatever value you've set your max results variable to. print('maximum number of results exceeded') break print('loop finished') list_length = len(contact_list) print("You've succesfully parsed through {} contact records and added them to a list".format(list_length))
// This example displays how to get all contacts from a HubID and paginate through them using the 'offset' parameter. // The end result is an array containing all parsed contacts. var request = require("request") const returnedContacts = []; const API_KEY = 'demo' const count = 5; function getContacts(offset) { if (typeof offset == 'undefined') { offsetParam = null; } else { offsetParam = `vidOffset=${offset}`; } const hapikeyParam = `hapikey=${API_KEY}` const paramsString = `?count=${count}&${hapikeyParam}&${offsetParam}`; const finalUrl = `https://api.hubapi.com/contacts/v1/lists/all/contacts/all${paramsString}` request(finalUrl, (error, response, body) => { if (error) { console.log('error', error) throw new Error } const parsedBody = JSON.parse(body) parsedBody.contacts.forEach(contact => { returnedContacts.push(contact); }); if (parsedBody['has-more']) { getContacts(parsedBody['vid-offset']) } else { //print out all contacts console.log(returnedContacts) } }) }; getContacts()