Ticket

Get details of a ticket

get/v1/tickets/{id}

Path parameters

idinteger required

Ticket identifier.

Response

idinteger

departmentIdinteger

Department (brand) this ticket belongs to. Derived from the pipeline on create (IDT-417).

subjectstring required

Ticket's subject

contactIdinteger

ID of the related contact

companyIdinteger nullable

ID of the related company

categoryIdsstring nullable

Category IDs separated by commas

ownerIdsstring nullable

IDs of the users assigned to this ticket, separated by commas

ownerGroupIdinteger nullable

IDs of the group assigned to this ticket

followerIdsstring nullable

IDs of the users following this ticket, separated by commas

createdContactIdinteger

createdAutomationIdinteger

createdUserIdinteger

createdDatestring date-time

updatedUserIdinteger

updatedDatestring date-time

startDatestring date-time nullable

Start date in UTC (yyyy-MM-dd HH:mm:ss)

dueDatestring date-time nullable

Due date in UTC (yyyy-MM-dd HH:mm:ss)

firstResponseDatestring date-time nullable

First response date in UTC (yyyy-MM-dd HH:mm:ss)

closingDatestring date-time nullable

Closing date in UTC (yyyy-MM-dd HH:mm:ss)

reopenDatestring date-time nullable

source1 | 2 | 3 | 4 | 5 | 6 required

Enum values:<ul><li>1 = Email</li><li>2 = Phone</li><li>3 = Chat</li><li>4 = Web</li><li>5 = Sms</li><li>6 = Manual</li></ul>

status1 | 2 | 3 | 4 required

Enum values:<ul><li>1 = Open</li><li>2 = Pending</li><li>3 = Resolved</li><li>4 = Closed</li></ul>

lastStatusChangeDatestring date-time nullable

priority1 | 2 | 3 | 4 required

Enum values:<ul><li>1 = Low</li><li>2 = Medium</li><li>3 = High</li><li>4 = Urgent</li></ul>

notesstring nullable

pipelineIdinteger required

ID of the pipeline that this ticket belongs to

stageIdinteger required

ID of the stage that this ticket belongs to

orderNointeger required

Kanban stage order

linkedType0 | 1 | 2 | 5 | 6 | 7 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 19 | 20 | 21 | 22 | 23 | 25 | 26 | 27 | 31 | 32 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 50 | 51 | 52 | 53 | 55 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 72

Infoset data objectsEnum values:<ul><li>0 = None</li><li>1 = Company</li><li>2 = Contacts</li><li>5 = Deals</li><li>6 = EmailLogs</li><li>7 = Emails</li><li>10 = MailAccounts</li><li>11 = MarketingLog</li><li>12 = MarketingSession</li><li>13 = MarketingTable</li><li>14 = Pipeline</li><li>15 = PipelineStages</li><li>16 = Todos</li><li>19 = TicketLogs</li><li>20 = Tickets</li><li>21 = Users</li><li>22 = Settings</li><li>23 = ContactGroups</li><li>25 = UserRights</li><li>26 = CustomUserRights</li><li>27 = UserGroups</li><li>31 = Automations</li><li>32 = Subjects</li><li>34 = Categories</li><li>35 = CallLogs</li><li>36 = Voicemails</li><li>37 = UserChannelRights</li><li>38 = CallCenterQueues</li><li>39 = DialPlans</li><li>40 = ServiceProviders</li><li>41 = IvrMenus</li><li>42 = IvrMenuDetails</li><li>43 = IvrPlugins</li><li>44 = VoipUsers</li><li>45 = DialerTable</li><li>46 = DialerSession</li><li>47 = DialerSessionLog</li><li>48 = DialerDtmfLink</li><li>50 = ChatRooms</li><li>51 = ChatTable</li><li>52 = ChatMessages</li><li>53 = ChatWidgets</li><li>55 = OutboundMessages</li><li>60 = ChatWidgetHomepage</li><li>61 = Chatbot</li><li>62 = ChatbotObject</li><li>63 = DealLogs</li><li>64 = SlaPolicies</li><li>65 = Sms</li><li>66 = Survey</li><li>67 = Announcements</li><li>68 = AnnouncementReadLogs</li><li>69 = AuditLogs</li><li>72 = Integrations</li></ul>

linkedIdinteger

Linked item ID

customFieldsstring nullable

A stringified JSON object mapping custom field names to values

Example: {"My Text Custom Field":"Field Value","My Numeric Custom Field":2}

isSpaminteger nullable

1 if the ticket is a spam, 0 (or null) otherwise

slaIdinteger nullable

If an SLA policy affects this ticket, ID of the attached SlaStats, otherwise null

mergeIdinteger nullable

If this ticket is merged with another ticket, ID of the root ticket, otherwise null

nextSlaBreachstring date-time nullable

Next SLA breach date in UTC (yyyy-MM-dd HH:mm:ss)

resolveTimeSecinteger nullable

Resolve time in seconds

resolveTimeBusinessSecinteger nullable

Resolve time in seconds (calculated in business hours)

frTimeSecinteger nullable

First response time in seconds

frTimeBusinessSecinteger nullable

First response time in seconds (calculated in business hours)

openTimeSecinteger nullable

The time ticket stayed in Open status

openTimeBusinessSecinteger nullable

The time ticket stayed in Open status (calculated in business hours)

pendingTimeSecinteger nullable

The time ticket stayed in Pending status

pendingTimeBusinessSecinteger nullable

The time ticket stayed in Pending status (calculated in business hours)

firstAssignTimeSecinteger nullable

First assign time in seconds

chatTagsstring nullable

callTagsstring nullable

Example response

{
  "subject": "Example ticket"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.