Get a deal

Last updated June 17, 2020

GET  /deals/v1/deal/:dealId

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

CRM

Required Scope:

contacts

The get a deal endpoint retrieves deal information from a HubSpot account, including any associated contact, company, and ticket information. It allows data syncing from HubSpot to external CRMs, accounting systems, forecasting software, and reporting applications. 

What's a use case for this endpoint? Your business uses HubSpot for sales and another project management system for onboarding new customers. When a HubSpot deal moves to the closed-won stage, the get a deal endpoint syncs the data to your project management software and initiates a new onboarding project.

Response details

Returns an object representing the deal with the associated account id :dealId.

Two important returned fields will identify the appropriate associations with the deal: associatedCompanyIds returns the id of the company associated with the deal, and associatedVids returns the ids of the contacts associated with the deal.

You can then look up either the contacts or the company.
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.
Deal Id Used in the request URL (see above) Unique identifier for a particular deal.
Optional Parameters How to use Description
Include property versions &includePropertyVersions=true By default, you will only get data for the most recent version of a property in the "versions" data. If you include this parameter, you will get data for all previous versions.