Get a ticket by ID

GET  /crm-objects/v1/objects/tickets/:id

This endpoint is part of our developer preview program, and should be considered as a non-stable release that will be subject to bugs and breaking changes while under development. Please take this into account as you build against a release. Please subscribe to our changelog for updates.

Method Details

HTTP Methods:

GET

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Service Hub

Required Scope:

tickets

Get a specific ticket by its ID.

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 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.
Ticket ID :id
Used in the request URL
The ID of the ticket you want to get.

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