Zendesk Ticket Fields 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 Fields. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.
This API exposes
11 operations
across 6 paths,
and defines 5 schemas.
It is described by OpenAPI 3.1.0, at version 1.0.
Requests are made against the base URL https://{subdomain}.zendesk.com.
11 operations6 paths5 schemas2 DELETE5 GET2 POST2 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 11
Across 6 paths, the API surfaces 11 operations — 2 DELETE, 5 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
Ticket Fields 11
GET
/api/v2/ticket_fields
Zendesk Get Api V2 Ticketfields
ListTicketFields2 params→ 200
POST
/api/v2/ticket_fields
Zendesk Post Api V2 Ticketfields
CreateTicketField→ 201
GET
/api/v2/ticket_fields/{ticket_field_id}
Zendesk Get Api V2 Ticketfields Ticketfieldid
ShowTicketfield2 params→ 200
PUT
/api/v2/ticket_fields/{ticket_field_id}
Zendesk Put Api V2 Ticketfields Ticketfieldid
UpdateTicketField2 params→ 200
DELETE
/api/v2/ticket_fields/{ticket_field_id}
Zendesk Delete Api V2 Ticketfields Ticketfieldid
DeleteTicketField2 params→ 204
GET
/api/v2/ticket_fields/{ticket_field_id}/options
Zendesk Get Api V2 Ticketfields Ticketfieldid Options
ListTicketFieldOptions1 param→ 200
POST
/api/v2/ticket_fields/{ticket_field_id}/options
Zendesk Post Api V2 Ticketfields Ticketfieldid Options
Zendesk Delete Api V2 Ticketfields Ticketfieldid Options Ticketfieldoptionid
DeleteTicketFieldOption2 params→ 204
GET
/api/v2/ticket_fields/count
Zendesk Get Api V2 Ticketfields Count
CountTicketFields→ 200
PUT
/api/v2/ticket_fields/reorder
Zendesk Put Api V2 Ticketfields Reorder
ReorderTicketFields→ 200
Schemas 5
The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are CustomFieldOptionsResponse (4 properties), CustomFieldOptionResponse (1 property), TicketFieldCountResponse (1 property), TicketFieldsResponse (1 property). Each schema is shown below with its type and property counts.
TicketFieldResponse
object
1 property
TicketFieldsResponse
object
1 property
CustomFieldOptionsResponse
object
4 properties
TicketFieldCountResponse
object
1 property
CustomFieldOptionResponse
object
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
