There's a new version of the HubSpot API

Starting November 30, 2022, API keys will be sunset as an authentication method. 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 June 17, 2020

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 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.
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