Get a Deal

Last updated July 3, 2019

GET  /deals/v1/deal/:dealId

Method Details

HTTP Methods:


Response Format:


Requires Authentication?


Rate Limited?






Required Scope:


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

Two important fields will be returned to you that 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 perform lookups on 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 company.
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.