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

Zendesk Ticket Audits API

The Ticket Audits API from Zendesk — 5 operation(s) for ticket audits.

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

This API exposes 2 JSON Schema definitions.

Tagged areas include Ticket Audits. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.

This API exposes 5 operations across 5 paths, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against the base URL https://{subdomain}.zendesk.com.

5 operations 5 paths 4 schemas 4 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://{subdomain}.zendesk.com
Resource Areas
1

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 4 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Ticket Audits 5
GET
/api/v2/ticket_audits
Zendesk Get Api V2 Ticketaudits
ListTicketAudits 3 params → 200
GET
/api/v2/tickets/{ticket_id}/audits
Zendesk Get Api V2 Tickets Ticketid Audits
ListAuditsForTicket 1 param → 200
GET
/api/v2/tickets/{ticket_id}/audits/{ticket_audit_id}
Zendesk Get Api V2 Tickets Ticketid Audits Ticketauditid
ShowTicketAudit 2 params → 200
PUT
/api/v2/tickets/{ticket_id}/audits/{ticket_audit_id}/make_private
Zendesk Put Api V2 Tickets Ticketid Audits Ticketauditid Makeprivate
MakeTicketCommentPrivateFromAudits 2 params → 200
GET
/api/v2/tickets/{ticket_id}/audits/count
Zendesk Get Api V2 Tickets Ticketid Audits Count
CountAuditsForTicket 1 param → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are TicketAuditsResponse (5 properties), TicketAuditsResponseNoneCursor (4 properties), TicketAuditResponse (1 property), TicketAuditsCountResponse (1 property). Each schema is shown below with its type and property counts.

TicketAuditsResponse
object
5 properties
TicketAuditsResponseNoneCursor
object
4 properties
TicketAuditsCountResponse
object
1 property
TicketAuditResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zendesk-ticket-audits-api-openapi.yml Raw ↑

Other APIs Zendesk publishes across the network.

Zendesk Help Center Articles API
Zendesk Help Center Sections API
Zendesk Help Center Categories API
Zendesk Help Center Translations API
Zendesk Help Center Article Attachments API
Zendesk Help Center Article Comments API
Zendesk Help Center Article Labels API
Zendesk Help Center Topics API
Zendesk Help Center Posts API
Zendesk Help Center Post Comments API
Zendesk Help Center Votes API
Zendesk Help Center Content Subscriptions API