There's a new version of the HubSpot API

As of November 30, 2022, HubSpot API keys are no longer a supported authentication method for accessing HubSpot APIs. Instead, you should use a private app access token or OAuth to authenticate API calls. Learn more about this change and how to migrate an API key integration to use a private app instead.

Get a group of tickets by ID

Last updated May 31, 2023

POST /crm-objects/v1/objects/tickets/batch-read

Method Details

HTTP Methods:

POST

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Service Hub

Required Scope:

tickets

Get a group of tickets by their IDs. Up to 100 IDs can be included in a single request.

By default, the response will only include the ID and a few system fields for the ticket. You can get specific properties in the response by using the properties parameter in the URL, and that parameter can be included multiple times to get multiple properties. See the example for more details.

Required Parameters How to use Description
OAuth access token or private app access token Authorization: Bearer {token} header Used to authenticate the request. Please see this page for more details about authentication.
Ticket IDs "ids": [ {list of IDs} ]
Used in the request JSON
An array of ticket IDs that you want to get. You can include up to 100 IDs in a single request.

Optional Parameters How to use Description
Ticket properties &properties=
Used in the request URL
By default, only the ID and a few other system fields are returned for the tickets. You can include ticket properties in the response by requesting them in the URL. This parameter can be included multiple times to request multiple properties. See the example for more details.
Ticket properties (with history) &propertiesWithHistory=
Used in the request URL
This parameter behaves exactly like the properties parameter above, with the exception that properties included with this parameter also return the full version history for the property.
Include deleted

&includeDeletes=true
Used in the request URL

By default, deleted records will not be returned by the API. You can include this parameter to make sure that records are returned even when they are deleted.