Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zoho Ticket API

The Ticket API from Zoho — 23 operation(s) for ticket.

Zoho Ticket API is one of 205 APIs that Zoho publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Ticket. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and code examples.

This API exposes 27 operations across 23 paths, and defines 30 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

27 operations 23 paths 30 schemas 1 DELETE11 GET2 PATCH13 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Authentication
custom
Resource Areas
1

Authentication & Security 1

Zoho Ticket API declares 1 security scheme for authenticating requests. It defines a custom scheme (iam-oauth2-schema).

Paths & Operations 27

Across 23 paths, the API surfaces 27 operations — 1 DELETE, 11 GET, 2 PATCH, 13 POST. Each is listed below with its method, path, parameters, and response codes.

Ticket 27
GET
/api/v1/tickets/{ticketId}/resolution
Get ticket resolution
getTicketResolution 2 params → 200
DELETE
/api/v1/tickets/{ticketId}/resolution
Delete ticket resolution
deleteTicketResolution 2 params → 204
PATCH
/api/v1/tickets/{ticketId}/resolution
Update ticket resolution
updateTicketResolution 2 params body → 422200
GET
/api/v1/agentsTicketsCount
List all agentsTicketsCount
getAgentsTicketsCount 3 params → 422200
POST
/api/v1/tickets/moveToTrash
Move Tickets to trash
deleteTicket 1 param body → 422204
GET
/api/v1/associatedTickets
List all associated tickets
getAssociatedTickets 12 params → 204200
POST
/api/v1/tickets/updateMany
Bulk update tickets
bulkUpdateTickets 1 param body → 422204403
POST
/api/v1/tickets/deleteSpam
Delete spam tickets
deleteSpamTickets 1 param body → 422200
GET
/api/v1/tickets/archivedTickets
Get Archived Ticket List
getArchivedTickets 6 params → 200422204403
POST
/api/v1/tickets/{ticketId}/move
Move ticket
moveTicket 2 params body → 422200
GET
/api/v1/tickets/{ticketId}/metrics
Get ticket metrics
getTicketsMetrics 2 params → 200
POST
/api/v1/tickets/{ticketId}/merge
Merge two tickets
mergeTicket 2 params body → 422200
POST
/api/v1/tickets/emptySpam
Empty spam tickets
deleteAllSpamTickets 1 param body → 422202
POST
/api/v1/tickets/{ticketId}/notifyArticleUsage
Map articles to tickets
mapArticlesToTicket 2 params body → 422204
GET
/api/v1/tickets/{ticketId}/resolutionHistory
Get resolution history
getTicketResolutionHistory 2 params → 200
POST
/api/v1/tickets/markSpam
Mark ticket as spam
markTicketAsSpam 1 param body → 422200403
GET
/api/v1/contacts/{contactId}/tickets
List tickets by contact
getTicketsByContact 9 params → 200204
POST
/api/v1/tickets/{ticketId}/markAsRead
Mark as read
markTicketAsRead 2 params → 200
GET
/api/v1/tickets
List all tickets
getTickets 13 params → 204200
POST
/api/v1/tickets
Create a ticket
createTicket 1 param body → 422400200
POST
/api/v1/closeTickets
Closed many tickets
closeTickets 1 param body → 422200
GET
/api/v1/ticketQueueView/count
List all ticketQueueView count
getTicketQueueViewCount 4 params → 422200
GET
/api/v1/tickets/{ticketId}
Get a ticket
getTicket 3 params → 200
PATCH
/api/v1/tickets/{ticketId}
Update a ticket
updateTicket 2 params body → 200422
POST
/api/v1/tickets/{ticketId}/markAsUnRead
Mark as unread
markTicketAsUnRead 2 params → 204
POST
/api/v1/tickets/{ticketId}/threads/{threadId}/split
Split tickets
splitThreadIntoNewTicket 3 params → 200
GET
/api/v1/products/{productId}/tickets
List tickets by products
getTicketsByProduct 9 params → 204200

Schemas 30

The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are mergeFieldJson (19 properties), commonKeys (9 properties), channelSource (6 properties), channelRelatedInfo (5 properties). Each schema is shown below with its type and property counts.

mergeFieldJson
nullobject
19 properties 19 required
resolutionResponse
nullobject
3 properties 3 required
commonJson
getCountJson
long_array
nullarray
assignee
nullobject
5 properties 5 required
ticketResponse
resolutionResponseData
nullarray
getUnassignedTicketsCount
nullobject
4 properties 4 required
channelRelatedInfo
nullobject
5 properties 5 required
data
nullarray
stagingData
nullarray
channelList
nullarray
sharedDepartmentsWithName
nullobject
3 properties 3 required
agentsHandled
nullobject
3 properties 3 required
commonResponse
listViewData
nullarray
commonRequestJson
lastThread
nullobject
4 properties 4 required
agentsHandledData
nullarray
channelSource
nullobject
6 properties 5 required
pagination
nullobject
2 properties 2 required
sharedDepartmentsWithNameArr
nullarray
getCountCommonJson
stagingJson
nullobject
2 properties 2 required
listviewJson
getAgentsTicketCountList
nullarray
listviewCommonJson
ticketListViewArray
nullobject
1 property 1 required
commonKeys
nullobject
9 properties 9 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zoho-ticket-api-openapi.yml Raw ↑

Other APIs Zoho publishes across the network.

Zoho Inventory
Zoho Books
Zoho Invoice
Zoho Billing
Zoho Expense
Zoho People
Zoho Recruit
Zoho Projects
Zoho Mail
Zoho Sign
Zoho Campaigns
Zoho SalesIQ