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 a deal property

Last updated May 15, 2023

GET /properties/v1/deals/properties/named/:property_name

Method Details

HTTP Methods:


Response Format:


Requires Authentication?


Rate Limited?






Required Scope:

Returns a JSON object representing the definition for a given deal property.

Looking for your deal stages? The dealstage property is controlled by the separate 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.
Property Name Used in the request URL The API name of the property that you are requesting
Optional Parameters How to use Description
None None No optional parameters for this method.

Example URL:

Note This replaces the deprecated URL GET deals/v1/properties/named/:property_name