Get all deal properties

Last updated December 30, 2019

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:

contacts

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

Example URL:  https://api.hubapi.com/properties/v1/deals/properties?hapikey=demo

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