There's a new version of the HubSpot API

Check out the new 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 deal property groups

Last updated June 17, 2020

GET /properties/v1/deals/groups

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 all of the deal property groups for a given portal.

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 Group Used in the request URL The access token or API key for the portal that you're making the call for.
Optional Parameters How to use Description
Include Properties &includeProperties=true (used in Request URL) Returns all of the properties for each deal property group.

Example URL to POST to:  https://api.hubapi.com/properties/v1/deals/groups?hapikey=demo&includeProperties=true

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

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: api.hubapi.com/properties/v1/deals/groups?hapikey=demo Example response: [ { "name": "salesforceinformation", "displayName": "", "displayOrder": -1, "properties": [ { "name": "hs_salesforceopportunityid", "label": "Opportunity ID", "description": "", "groupName": "salesforceinformation", "type": "string", "fieldType": "text", "options": [ ], "formField": false, "displayOrder": 0, "readOnlyValue": false, "readOnlyDefinition": false, "hidden": false, "mutableDefinitionNotDeletable": false, "calculated": false, "externalOptions": false, "displayMode": "current_value" } ] }, { "name": "dealinformation", "displayName": "Deal Information", "displayOrder": 0, "properties": [ { "name": "hubspot_owner_assigneddate", "label": "Owner Assigned Date", "description": "The timestamp when an owner was assigned to this deal", "groupName": "dealinformation", "type": "datetime", "fieldType": "text", "options": [ ], "formField": false, "displayOrder": -1, "readOnlyValue": true, "readOnlyDefinition": true, "hidden": false, "mutableDefinitionNotDeletable": true, "calculated": false, "externalOptions": false, "displayMode": "current_value", "hubspotDefined": true }, { "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", "options": [ { "description": "", "label": "Appointment Scheduled", "displayOrder": 1, "hidden": false, "doubleData": 0.2, "readOnly": false, "value": "appointmentscheduled" }, { "description": "", "label": "Qualified To Buy", "displayOrder": 2, "hidden": false, "doubleData": 0.4, "readOnly": false, "value": "qualifiedtobuy" }, { "description": "", "label": "Presentation Scheduled", "displayOrder": 3, "hidden": false, "doubleData": 0.6, "readOnly": false, "value": "presentationscheduled" }, { "description": "", "label": "Contract Sent", "displayOrder": 4, "hidden": false, "doubleData": 0.9, "readOnly": false, "value": "contractsent" }, { "description": "", "label": "Closed Won", "displayOrder": 5, "hidden": false, "doubleData": 1, "readOnly": false, "value": "closedwon" }, { "description": "", "label": "Upgraded", "displayOrder": 6, "hidden": false, "doubleData": 1, "readOnly": false, "value": "upgraded" }, { "description": "", "label": "Closed Lost", "displayOrder": 7, "hidden": false, "doubleData": 0, "readOnly": false, "value": "closedlost" }, { "description": " ", "label": "Customer Cancelled", "displayOrder": 8, "hidden": false, "doubleData": 0, "readOnly": false, "value": "customercancelled" }, { "description": null, "label": "Prospecting", "displayOrder": -1, "hidden": false, "doubleData": 0.1, "readOnly": false, "value": "Prospecting" } ], "formField": false, "displayOrder": 5, "readOnlyValue": false, "readOnlyDefinition": false, "hidden": false, "mutableDefinitionNotDeletable": true, "calculated": false, "externalOptions": false, "displayMode": "current_value", "hubspotDefined": true, "updatedUserId": 410867 }, { "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 }, { "name": "invoicenumber", "label": "Invoice Number", "description": "", "groupName": "dealinformation", "type": "string", "fieldType": "text", "options": [ ], "formField": true, "displayOrder": 10, "readOnlyValue": false, "readOnlyDefinition": false, "hidden": false, "mutableDefinitionNotDeletable": false, "calculated": false, "externalOptions": false, "displayMode": "current_value" } ] }, { "name": "invoicing", "displayName": "Invoicing", "displayOrder": 1, "properties": [ ] }, { "name": "invoicing2", "displayName": "Invoicing2", "displayOrder": 2, "properties": [ ] } ]