There's a new version of the HubSpot API

Check out the new API
View Beta Docs

We're also working on a new documentation website, you're invited to check it out and give us your feedback.

Get all deal properties

Last updated May 15, 2023

GET /properties/v1/deals/properties/

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

Deal properties store specific information for deal records. The get all deal properties endpoint retrieves all default and custom deal properties from a HubSpot account, including their definitions. 

What's a use case for this endpoint? Your company wants to recreate HubSpot deals in an external CRM system. You decide to use the Get All Deal Properties endpoint to retrieve all default and custom deal properties in HubSpot. The required properties can then be parsed from the response and used in your external CRM.

Looking for your deal stages? The dealstage property is controlled by the 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.
Optional Parameters How to use Description
None None No optional parameters for this method.

Example URL:  https://api.hubapi.com/properties/v1/deals/properties

Note This replaces the deprecated URL GET /deals/v1/properties/

About

Jobs

Learn Inbound

Support

Locations

HubSpot, Inc.
25 First Street, 2nd Floor
Cambridge, MA 02141
European Headquarters
Ground Floor, Two Dockland Central
Guild Street, Dublin 1
Asia/Pacific Office
20 Hunter St, Level 7
Sydney NSW 2000
View our other locations
Example GET URL: https://api.hubapi.com/properties/v1/deals/properties/ Returns all of the deal property definitions: [ { "name": "dealname", "label": "Deal Name", "description": "Name of the deal", "groupName": "dealinformation", "type": "string", "fieldType": "text", "options": [], "formField": false, "displayOrder": 0, "readOnlyValue": false, "readOnlyDefinition": true, "hidden": false, "mutableDefinitionNotDeletable": true, "calculated": false, "externalOptions": false, "displayMode": "current_value", "hubspotDefined": true }, { "name": "closedate", "label": "Close Date", "description": "The expected close date of the deal", "groupName": "dealinformation", "type": "datetime", "fieldType": "text", "options": [], "formField": false, "displayOrder": 4, "readOnlyValue": false, "readOnlyDefinition": true, "hidden": false, "mutableDefinitionNotDeletable": true, "calculated": false, "externalOptions": false, "displayMode": "current_value", "hubspotDefined": true }, { "name": "createdate", "label": "Create Date", "description": "The date the deal was created", "groupName": "dealinformation", "type": "datetime", "fieldType": "text", "options": [], "formField": false, "displayOrder": 5, "readOnlyValue": false, "readOnlyDefinition": true, "hidden": false, "mutableDefinitionNotDeletable": true, "calculated": false, "externalOptions": false, "displayMode": "current_value", "hubspotDefined": true }, { "name": "dealstage", "label": "Deal Stage", "description": "The stage of the deal", "groupName": "dealinformation", "type": "enumeration", "fieldType": "radio", "readOnlyDefinition": true, "updatedAt": 1457479889399, "formField": false, "displayOrder": 3, "readOnlyValue": false, "hidden": false, "mutableDefinitionNotDeletable": true, "favorited": false, "hubspotDefined": true, "favoritedOrder": -1, "calculated": false, "externalOptions": true, "displayMode": "current_value", "showCurrencySymbol": null, "createdUserId": null, "textDisplayHint": null, "numberDisplayHint": null, "optionsAreMutable": true, "referencedObjectType": null, "isCustomizedDefault": false, "searchableInGlobalSearch": false, "currencyPropertyName": null, "hasUniqueValue": false, "deleted": false, "options": [], "updatedUserId": null, "createdAt": 1434717529447 }, { "name": "notes_last_updated", "label": "Notes Last Updated", "description": "The last timestamp when a note was updated for this deal, or an associated contact or company", "groupName": "dealinformation", "type": "datetime", "fieldType": "text", "options": [], "formField": false, "displayOrder": 6, "readOnlyValue": true, "readOnlyDefinition": true, "hidden": false, "mutableDefinitionNotDeletable": true, "calculated": false, "externalOptions": false, "displayMode": "current_value", "hubspotDefined": true }, { "name": "notes_last_contacted", "label": "Last Contacted", "description": "The last timestamp when a call, email or meeting was logged for this deal, an associated company or contact", "groupName": "dealinformation", "type": "datetime", "fieldType": "text", "options": [], "formField": false, "displayOrder": 6, "readOnlyValue": true, "readOnlyDefinition": true, "hidden": false, "mutableDefinitionNotDeletable": true, "calculated": false, "externalOptions": false, "displayMode": "current_value", "hubspotDefined": true }, { "name": "hs_createdate", "label": "HubSpot Create Date", "description": "The date the deal was created in HubSpot", "groupName": "dealinformation", "type": "datetime", "fieldType": "text", "options": [], "formField": false, "displayOrder": 6, "readOnlyValue": true, "readOnlyDefinition": true, "hidden": true, "mutableDefinitionNotDeletable": true, "calculated": false, "externalOptions": false, "displayMode": "current_value", "hubspotDefined": true }, { "name": "googledrivefolderid", "label": "Google Drive Folder Id", "description": "The id of the Google Drive Folder associated with this deal.", "groupName": "dealinformation", "type": "string", "fieldType": "text", "options": [], "formField": false, "displayOrder": 6, "readOnlyValue": true, "readOnlyDefinition": true, "hidden": true, "mutableDefinitionNotDeletable": true, "calculated": false, "externalOptions": false, "displayMode": "current_value" }, { "name": "hubspot_owner_id", "label": "HubSpot Owner", "description": "The owner of the deal", "groupName": "dealinformation", "type": "enumeration", "fieldType": "select", "options": [], "formField": false, "displayOrder": 6, "readOnlyValue": false, "readOnlyDefinition": true, "hidden": false, "mutableDefinitionNotDeletable": true, "calculated": false, "externalOptions": true, "displayMode": "current_value", "hubspotDefined": true }, { "name": "dealtype", "label": "Deal Type", "description": "Type of the deal", "groupName": "dealinformation", "type": "enumeration", "fieldType": "radio", "options": [ { "description": null, "label": "New Business", "displayOrder": 0, "hidden": false, "doubleData": 0, "readOnly": false, "value": "newbusiness" }, { "description": null, "label": "existingBusiness", "displayOrder": 1, "hidden": false, "doubleData": 0, "readOnly": false, "value": "existingbusiness" }, { "description": null, "label": "Existing Customer - Upgrade", "displayOrder": -1, "hidden": true, "doubleData": 0, "readOnly": false, "value": "Existing Customer - Upgrade" } ], "formField": false, "displayOrder": 7, "readOnlyValue": false, "readOnlyDefinition": true, "hidden": false, "mutableDefinitionNotDeletable": true, "calculated": false, "externalOptions": false, "displayMode": "current_value", "hubspotDefined": true }, { "name": "deal_source", "label": "Deal Source", "description": "", "groupName": "dealinformation", "type": "enumeration", "fieldType": "select", "options": [ { "description": null, "label": "Online", "displayOrder": 0, "hidden": false, "doubleData": null, "readOnly": null, "value": "Online" }, { "description": null, "label": "Offline", "displayOrder": 1, "hidden": false, "doubleData": null, "readOnly": null, "value": "Offline" }, { "description": null, "label": "Other", "displayOrder": 2, "hidden": false, "doubleData": null, "readOnly": null, "value": "Other" } ], "formField": true, "displayOrder": 7, "readOnlyValue": false, "readOnlyDefinition": false, "hidden": false, "mutableDefinitionNotDeletable": false, "calculated": false, "externalOptions": false, "displayMode": "current_value", "updatedUserId": 100291 }, { "name": "amount", "label": "Amount", "description": "", "groupName": "dealinformation", "type": "number", "fieldType": "text", "options": [], "formField": false, "displayOrder": 8, "readOnlyValue": false, "readOnlyDefinition": false, "hidden": false, "mutableDefinitionNotDeletable": false, "calculated": false, "externalOptions": false, "displayMode": "current_value" }, { "name": "description", "label": "Deal Description", "description": "Description of the deal", "groupName": "dealinformation", "type": "string", "fieldType": "text", "options": [], "formField": false, "displayOrder": 8, "readOnlyValue": false, "readOnlyDefinition": true, "hidden": false, "mutableDefinitionNotDeletable": true, "calculated": false, "externalOptions": false, "displayMode": "current_value", "hubspotDefined": true }, { "name": "salesforcecampaign", "label": "Campaign", "description": "", "groupName": "dealinformation", "type": "string", "fieldType": "text", "options": [], "formField": false, "displayOrder": 9, "readOnlyValue": false, "readOnlyDefinition": false, "hidden": false, "mutableDefinitionNotDeletable": false, "calculated": false, "externalOptions": false, "displayMode": "current_value" }, { "name": "num_associated_contacts", "label": "Number of Contacts", "description": "Number of contacts associated with this deal", "groupName": "dealinformation", "type": "number", "fieldType": "text", "options": [], "formField": false, "displayOrder": 9, "readOnlyValue": true, "readOnlyDefinition": true, "hidden": false, "mutableDefinitionNotDeletable": true, "calculated": true, "externalOptions": false, "displayMode": "current_value", "hubspotDefined": true } ]