Get a deal property

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

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