There's a new version of the HubSpot API
We're also working on a new documentation website, you're invited to check it out and give us your feedback.
HTTP Methods:
GET
Response Format:
json
Requires Authentication?
Yes
Rate Limited?
Headers
Products:
Marketing & CRM
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.
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