There's a new version of the HubSpot API
We're also working on a new documentation website, you're invited to check it out and give us your feedback.
HTTP Methods:
GET
Response Format:
json
Requires Authentication?
Yes
Rate Limited?
Headers
Products:
CRM
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 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: https://api.hubapi.com/properties/v1/deals/properties/named/dealname
Note This replaces the deprecated URL GET deals/v1/properties/named/:property_name
