There's a new version of the HubSpot API

As of November 30, 2022, HubSpot API keys are no longer a supported authentication method for accessing HubSpot APIs. Instead, you should use a private app access token or OAuth to authenticate API calls. Learn more about this change and how to migrate an API key integration to use a private app instead.

Get deal property groups

Last updated May 31, 2023

GET /properties/v1/deals/groups

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

CRM

Required Scope:

crm.schemas.deals.read

Returns all of the deal property groups for a given portal.

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.
Property Group Used in the request URL The access token or API key for the portal that you're making the call for.
Optional Parameters How to use Description
Include Properties &includeProperties=true (used in Request URL) Returns all of the properties for each deal property group.

Example URL to POST to:  https://api.hubapi.com/properties/v1/deals/groups?includeProperties=true

Note This replaces the deprecated URL GET /deals/v1/groups