Skip to main content
GET
/
deals
/
v1
/
deal
/
paged
Get all deals
curl --request GET \
  --url https://api.hubapi.com/deals/v1/deal/paged
{
  "deals": [
    {}
  ],
  "hasMore": true,
  "offset": 123
}

​
Required Scopes

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

Query Parameters

​
limit
integer

The number of records to return. Defaults to 100, has a maximum value of 250.

Required range: x <= 250
​
offset
integer

Used to page through the results. If there are more records in your account than the limit= parameter, you will need to use the offset returned in the first request to get the next set of results.

​
properties
string[]

Used to include specific deal properties in the results. By default, the results will only include Deal ID and will not include the values for any properties for your Deals. Including this parameter will include the data for the specified property in the results. You can include this parameter multiple times to request multiple properties.

​
propertiesWithHistory
string[]

Works similarly to properties=, but this parameter will include the history for the specified property, instead of just including the current value. Use this parameter when you need the full history of changes to a property's value.

​
includeAssociations
boolean

Include the IDs of the associated contacts and companies in the results. This will also automatically include the num_associated_contacts property.

​
includePropertyVersions
boolean

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.

Response

200 - application/json

Successful response - Paginated list of deals

​
deals
object[]
​
hasMore
boolean
​
offset
integer