Qodex.ai

Get ticket history

GET {{baseUrl}}/v1/tickets/:ticket_id/History

This API fetches details of all actions — called events — performed on a ticket and in the sub-tabs on the ticket detail page. To view a detailed documentation for this API, visit this page.

OAuth Scope

  • Desk.tickets.READ

Request Params

KeyDatatypeRequiredDescription
fromstringIndex number, starting from which the events must be fetched
limitstringNumber of events to list
eventFilterstringKey that filters events, based on their type. Values allowed are: CommentHistory, TimeEntryHistory, TaskHistory, CallHistory, EventHistory, AttachmentHistory, ApprovalHistory, SuperviseHistory, WorkflowHistory, MacroHistory, AssignmentRuleHistory, NotificationRuleHistory, SLAHistory, BlueprintHistory and SkillRelatedHistory
agentIdstringKey that filters details of actions performed by a particular agent. Value allowed is the agent's ID in Zoho Desk.
fieldNamestringKey that filters the history of a particular field. The value for this key must be the apiName of the field.

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"data":[{"actor":{"name":"Aadavan","id":"7000000025001","type":"Contact"},"eventInfo":[{"propertyName":"Department","propertyType":"Entity","systemProperty":true,"propertyValue":{"name":"Zylker Primary","id":"7000000013224","type":"Department"}},{"propertyName":"Account Name","propertyType":"Text","systemProperty":true,"propertyValue":"Primary Account"},{"propertyName":"Contact Name","propertyType":"Text","systemProperty":true,"propertyValue":"Aadavan"},{"propertyName":"Email","propertyType":"Text","systemProperty":true,"propertyValue":"aathavan@zylker.com"},{"propertyName":"Subject","propertyType":"Text","systemProperty":true,"propertyValue":"Ticket Subject"},{"propertyName":"Description","propertyType":"Text","systemProperty":true,"propertyValue":"\u003cdiv\u003eDescription.\u003cbr /\u003e\u003c/div\u003e"},{"propertyName":"Status","propertyType":"Text","systemProperty":true,"propertyValue":"Open"},{"propertyName":"Case Owner","propertyType":"Entity","systemProperty":true,"propertyValue":{"name":"Imman","id":"7000000000059","type":"Agent"}},{"propertyName":"Channel","propertyType":"Text","systemProperty":true,"propertyValue":"Email"},{"propertyName":"Is Escalated","propertyType":"Boolean","systemProperty":true,"propertyValue":false}],"eventTime":"2020-06-03T11:14:52.000Z","eventName":"TicketCreated","source":"Email","actorInfo":[]}]}