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 Company Property Groups

Last updated May 31, 2023

GET /properties/v1/companies/groups/

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing & CRM

Required Scope:

crm.schemas.companies.read

Returns all of the company property groups for a portal. Property groups are used to organize properties.  When viewing company properties in HubSpot, the properties will be sorted by their property group.  If your integration creates company properties, it's a good practice to create a group specifically for the properties for your integration.

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
Include Properties &includeProperties=true (used in Request URL) Returns all of the properties for each company property group.

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/properties/v1/companies/groups Example JSON Response: [ { "name": "companyinformation", "displayName": "Company Information", "displayOrder": 1, "hubspotDefined": false }, { "name": "socialmediainformation", "displayName": "Social Media Information", "displayOrder": 2, "hubspotDefined": false }, { "name": "emailinformation", "displayName": "Email Information", "displayOrder": 3, "hubspotDefined": false }, { "name": "analyticsinformation", "displayName": "Web Analytics History", "displayOrder": 4, "hubspotDefined": false }, { "name": "conversioninformation", "displayName": "Conversion Information", "displayOrder": 5, "hubspotDefined": false } ]