Get all companies

Last updated June 17, 2020

GET /companies/v2/companies/paged

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing & CRM

Required Scope:

contacts

This endpoint is used to get all of the companies in a HubSpot account.

Use case for this endpoint: This endpoint is useful when you're installing a new application and need to sync company data from HubSpot. For example, if you install an app that integrates HubSpot with an Enterprise Resource Planning app (ERP), that app may want to get all the company records stored in the CRM. It could then match them to customer records stored in the ERP and use webhooks to get incremental updates. 

Response details

If the request is successful, it returns a paginated list of companies.

In addition to the list of companies, each request will also return two values, offset and has-more. If has-more is true, you'll need to make another request, using the offset to get the next page of company records. These are often used with a recursive function in order to get all companies stored in a CRM. 

Required parameters How to use Description
OAuth Access Token or API key Authorization: Bearer {token} header
or hapikey={key} query parameter.		 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 portal 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=
Used in the request URL, may be included multiple times.		 Used to include specific company properties in the results.  By default, the results will only include the company ID, and will not include the values for any properties for your companies.  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: Companies that do not have a value set for a property will not include that property, even when you specify the property. A company without a value for the website property would not show the website property in the results, even with &properties=website 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.
Include merge audits &includeMergeAudits=true
Used in the request URL		 Returns any merge history if a company has been previously merged with another company record. Defaults to false.

 

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/companies/v2/companies/paged?hapikey=demo&properties=name&properties=website&limit=2 Example Response: { "companies": [ { "portalId": 62515, "additionalDomains": [ ], "properties": { "website": { "sourceId": null, "timestamp": 1457513066540, "versions": [ { "timestamp": 1457513066540, "sourceVid": [ ], "name": "website", "value": "example.com", "source": "COMPANIES" } ], "value": "example.com", "source": "COMPANIES" }, "name": { "sourceId": "name", "timestamp": 1464484587592, "versions": [ { "name": "name", "sourceId": "name", "timestamp": 1464484587592, "value": "Example Company", "source": "BIDEN", "sourceVid": [ ] } ], "value": "Example Company", "source": "BIDEN" } }, "isDeleted": false, "companyId": 115200636 }, { "portalId": 62515, "additionalDomains": [ ], "properties": { "website": { "sourceId": null, "timestamp": 1457535205549, "versions": [ { "timestamp": 1457535205549, "sourceVid": [ ], "name": "website", "value": "test.com", "source": "COMPANIES" } ], "value": "test.com", "source": "COMPANIES" }, "name": { "sourceId": "name", "timestamp": 1468832771769, "versions": [ { "name": "name", "sourceId": "name", "timestamp": 1468832771769, "value": "Test Company", "source": "BIDEN", "sourceVid": [ ] } ], "value": "Test Company", "source": "BIDEN" } }, "isDeleted": false, "companyId": 115279791 } ], "has-more": true, "offset": 115279791 }
# This example displays how to get all companies from a HubID and paginate through them using the 'offset' parameter. # The end result is a python list containing all parsed companies. import requests import json import urllib max_results = 500 hapikey = 'demo' limit = 5 company_list = [] get_all_companies_url = "https://api.hubapi.com/companies/v2/companies/paged?" parameter_dict = {'hapikey': hapikey, 'limit': limit} headers = {} # Paginate your request using offset has_more = True while has_more: parameters = urllib.urlencode(parameter_dict) get_url = get_all_companies_url + parameters r = requests.get(url= get_url, headers = headers) response_dict = json.loads(r.text) has_more = response_dict['has-more'] company_list.extend(response_dict['companies']) parameter_dict['offset']= response_dict['offset'] if len(company_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(company_list) print("You've succesfully parsed through {} company records and added them to a list".format(list_length))
// This example displays how to get all companies from a HubID and paginate through them using the 'offset' parameter. // The end result is an array containing all parsed companies. var request = require("request") const returnedCompanies = []; const API_KEY = 'demo' const count = 5; function getCompanies(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/companies/v2/companies/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.companies.forEach(company => { returnedCompanies.push(company); }); if (parsedBody['has-more']) { getCompanies(parsedBody['offset']) } else { //print out all companies console.log(returnedCompanies) } }) }; getCompanies()