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 deals

Last updated May 12, 2023

GET /deals/v1/deal/paged

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

CRM

Required Scope:

crm.objects.deals.read

The get all deals endpoint retrieves all deal data from HubSpot, including any associated object data. It returns a paginated set of deals.

What's a use case for this endpoint? Your company uses HubSpot and just added an external CRM. You’re beginning the process of integrating the two systems and deals are your top priority. You can use the get all deals endpoint to retrieve all existing deal information from HubSpot. You can then populate your CRM with this information before setting up a bi-directional sync.

Response details

In addition to the list of deals, each request will also return two values, offset and hasMore. If hasMore is true, you'll need to make another request, using the offset to get the next page of deal records.

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
Limit limit=
Used in the request URL		 The number of records to return. Defaults to 100, has a maximum value of 250.
Offset offset=
Used in the request URL		 Used to page through the results. If there are more records in your account than the limit= parameter, you will need to use the offset returned in the first request to get the next set of results.
Properties properties=x&properties=y
Used in the request URL, may be included multiple times to get multiple properties.		 Used to include specific deal properties in the results.  By default, the results will only include Deal ID and will not include the values for any properties for your Deals.  Including this parameter will include the data for the specified property in the results.  You can include this parameter multiple times to request multiple properties.
Note: Deals that do not have a value set for a property will not include that property, even when you specify the property. A deal without a value for the dealname property would not show the dealname property in the results, even with &properties=dealname in the URL.
Properties with History propertiesWithHistory=
Used in the request URL, may be included multiple times.		 Works similarly to properties=, but this parameter will include the history for the specified property, instead of just including the current value. Use this parameter when you need the full history of changes to a property's value.
Associations includeAssociations=true
Used in the request URL		 Include the IDs of the associated contacts and companies in the results. This will also automatically include the num_associated_contacts property.

 

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/deals/v1/deal/paged?includeAssociations=true&limit=2&properties=dealname { "deals": [ { "portalId": 62515, "dealId": 18039629, "isDeleted": false, "associations": { "associatedVids": [ 393873, 734934 ], "associatedCompanyIds": [ 237892 ], "associatedDealIds": [ ] }, "properties": { "dealname": { "value": "Company", "timestamp": 1457040864519, "source": "API", "sourceId": null, "versions": [ { "name": "dealname", "value": "Company Name", "timestamp": 1457040864519, "source": "API", "sourceVid": [ ] } ] }, "num_associated_contacts": { "value": "2", "timestamp": 0, "source": "CALCULATED", "sourceId": null, "versions": [ { "name": "num_associated_contacts", "value": "2", "source": "CALCULATED", "sourceVid": [ ] } ] } }, "imports": [ ] }, { "portalId": 62515, "dealId": 18040854, "isDeleted": false, "associations": { "associatedVids": [ ], "associatedCompanyIds": [ ], "associatedDealIds": [ ] }, "properties": { "dealname": { "value": "5678", "timestamp": 1457042290572, "source": "API", "sourceId": null, "versions": [ { "name": "dealname", "value": "5678", "timestamp": 1457042290572, "source": "API", "sourceVid": [ ] } ] }, "num_associated_contacts": { "value": "0", "timestamp": 0, "source": "CALCULATED", "sourceId": null, "versions": [ { "name": "num_associated_contacts", "value": "0", "source": "CALCULATED", "sourceVid": [ ] } ] } }, "imports": [ ] } ], "hasMore": true, "offset": 18040854 }
# This example displays how to get all deals from a HubID and paginate through them using the 'offset' parameter. # The end result is a python list containing all parsed deals. import requests import json import urllib max_results = 500 hapikey = 'demo' limit = 5 deal_list = [] get_all_deals_url = "https://api.hubapi.com/deals/v1/deal/paged?" parameter_dict = {'hapikey': hapikey, 'limit': limit} headers = {} # Paginate your request using offset has_more = True while has_more: parameters = urllib.parse.urlencode(parameter_dict) get_url = get_all_deals_url + parameters r = requests.get(url= get_url, headers = headers) response_dict = json.loads(r.text) has_more = response_dict['hasMore'] deal_list.extend(response_dict['deals']) parameter_dict['offset']= response_dict['offset'] if len(deal_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(deal_list) print("You've succesfully parsed through {} deal records and added them to a list".format(list_length))
// This example displays how to get all deals from a HubID and paginate through them using the 'offset' parameter. // The end result is an array containing all parsed deals. var request = require("request") const returnedDeals = []; const API_KEY = 'demo' const count = 5; function getDeals(offset) { if (typeof offset == 'undefined') { offsetParam = null; } else { offsetParam = `offset=${offset}`; } const hapikeyParam = `hapikey=${API_KEY}` const paramsString = `?count=${count}&${hapikeyParam}&${offsetParam}`; const finalUrl = `https://api.hubapi.com/deals/v1/deal/paged${paramsString}` console.log(finalUrl) request(finalUrl, (error, response, body) => { if (error) { console.log('error', error) throw new Error } const parsedBody = JSON.parse(body) parsedBody.deals.forEach(deal => { returnedDeals.push(deal); }); if (parsedBody['hasMore']) { getDeals(parsedBody['offset']) } else { //print out all deals console.log(returnedDeals) } }) }; getDeals()