GET
/
crm
/
v3
/
objects
/
discounts
List
curl --request GET \
  --url https://api.hubapi.com/crm/v3/objects/discounts \
  --header 'Authorization: Bearer <token>'
{
  "paging": {
    "next": {
      "after": "NTI1Cg%3D%3D",
      "link": "?after=NTI1Cg%3D%3D"
    }
  },
  "results": [
    {
      "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.line_items.read

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
limit
integer
default:10

The maximum number of results to display per page.

​
after
string

The paging cursor token of the last successfully read resource will be returned as the paging.next.after JSON property of a paged response containing more results.

​
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. Usage of this parameter will reduce the maximum number of discounts that can be read by a single request.

​
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.

Response

200
application/json

successful operation

The response is of type object.