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 Forms API

The Ticket Forms API from Zendesk — 7 operation(s) for ticket forms.

Zendesk Ticket Forms 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 Forms. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.

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

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

12 operations 7 paths 3 schemas 1 DELETE4 GET3 POST4 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 12

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

Ticket Forms 12
GET
/api/v2/ticket_forms/{ticket_form_id}/ticket_form_statuses
Zendesk Get Api V2 Ticketforms Ticketformid Ticketformstatuses
TicketFormTicketFormStatuses 1 param → 200
POST
/api/v2/ticket_forms/{ticket_form_id}/ticket_form_statuses
Zendesk Post Api V2 Ticketforms Ticketformid Ticketformstatuses
CreateTicketFormStatuses 1 param body → 200
PUT
/api/v2/ticket_forms/{ticket_form_id}/ticket_form_statuses
Zendesk Put Api V2 Ticketforms Ticketformid Ticketformstatuses
UpdateTicketFormStatuses 1 param body → 200
PUT
/api/v2/ticket_forms/{ticket_form_id}/ticket_form_statuses/{ticket_form_status_id}
Zendesk Put Api V2 Ticketforms Ticketformid Ticketformstatuses Ticketformstatusid
UpdateTicketFormStatusById 2 params body → 200
GET
/api/v2/ticket_forms
Zendesk Get Api V2 Ticketforms
ListTicketForms 4 params → 200
POST
/api/v2/ticket_forms
Zendesk Post Api V2 Ticketforms
CreateTicketForm → 201
GET
/api/v2/ticket_forms/{ticket_form_id}
Zendesk Get Api V2 Ticketforms Ticketformid
ShowTicketForm 1 param → 200
PUT
/api/v2/ticket_forms/{ticket_form_id}
Zendesk Put Api V2 Ticketforms Ticketformid
UpdateTicketForm 1 param → 200
DELETE
/api/v2/ticket_forms/{ticket_form_id}
Zendesk Delete Api V2 Ticketforms Ticketformid
DeleteTicketForm 1 param → 204
POST
/api/v2/ticket_forms/{ticket_form_id}/clone
Zendesk Post Api V2 Ticketforms Ticketformid Clone
CloneTicketForm 1 param → 200
PUT
/api/v2/ticket_forms/reorder
Zendesk Put Api V2 Ticketforms Reorder
ReorderTicketForms → 200
GET
/api/v2/ticket_forms/show_many
Zendesk Get Api V2 Ticketforms Showmany
ShowManyTicketForms 5 params → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are TicketFormsResponse (1 property), TicketFormStatusesResponse (1 property), TicketFormResponse (1 property). Each schema is shown below with its type and property counts.

TicketFormResponse
object
1 property
TicketFormStatusesResponse
object
1 property
TicketFormsResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zendesk-ticket-forms-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