There's a new version of the HubSpot API

As of November 30, 2022, HubSpot API Keys are being deprecated and are no longer supported. Continued use of HubSpot API Keys is a security risk to your account and data. Your API Keys could be deactivated at any time after Nov. 30th, and we recommend that you migrate to Private Apps as soon as possible so you do not lose business-critical functionality.

Get a deal property

Last updated June 17, 2020

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

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 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:  https://api.hubapi.com/properties/v1/deals/properties/named/dealname?hapikey=demo

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