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 all deal properties

Last updated May 15, 2023

GET /properties/v1/deals/properties/

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

Deal properties store specific information for deal records. The get all deal properties endpoint retrieves all default and custom deal properties from a HubSpot account, including their definitions. 

What's a use case for this endpoint? Your company wants to recreate HubSpot deals in an external CRM system. You decide to use the Get All Deal Properties endpoint to retrieve all default and custom deal properties in HubSpot. The required properties can then be parsed from the response and used in your external CRM.

Looking for your deal stages? The dealstage property is controlled by the CRM Pipelines API.

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
None None No optional parameters for this method.

Example URL:  https://api.hubapi.com/properties/v1/deals/properties

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