GET
/
crm
/
v3
/
objects
/
deals
/
{dealId}
Read
curl --request GET \
  --url https://api.hubapi.com/crm/v3/objects/deals/{dealId} \
  --header 'Authorization: Bearer <token>'
{
  "associations": "",
  "createdAt": "2023-11-07T05:31:56Z",
  "archived": false,
  "archivedAt": "2023-11-07T05:31:56Z",
  "propertiesWithHistory": "",
  "id": "",
  "objectWriteTraceId": "<string>",
  "properties": "",
  "updatedAt": "2023-11-07T05:31:56Z"
}
Supported products
Requires one of the following products or higher.
Marketing HubMarketing HubFree
Sales HubSales HubFree
Service HubService HubFree
Content HubContent HubFree

​
Required Scopes

This API requires one of the following scopes:
  • crm.objects.deals.read

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
dealId
string
required

Query Parameters

​
properties
string[]

A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.

​
propertiesWithHistory
string[]

A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.

​
associations
string[]

A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.

​
archived
boolean
default:false

Whether to return only results that have been archived.

​
idProperty
string

The name of a property whose values are unique for this object

Response

200
application/json

successful operation

Represents a CRM object along with its properties, timestamps, and a set of associated object IDs grouped by association type.