Zendesk Ticket Forms API

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

Operations 12

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/v2/ticket_forms List ticket forms · Zendesk Get Api V2 Ticket_forms #
Ask an LLM
“What ticket forms exist in my Zendesk account?”
“Can I list only the ticket forms end users can see?”
Tell an agent
List all ticket forms.
List ticket forms where active is {active} and end-user visible is {end_user_visible}.
POST /api/v2/ticket_forms Create a ticket form · Zendesk Post Api V2 Ticket_forms #
Ask an LLM
“Can I create a new ticket form with its own set of fields?”
“Who is allowed to create ticket forms?”
Tell an agent
Create a ticket form for billing requests.
Add a new ticket form with these fields.
GET /api/v2/ticket_forms/{ticket_form_id} Get a ticket form · Zendesk Get Api V2 Ticket_forms Ticket_form_id #
Ask an LLM
“How do I see the fields and settings of one ticket form?”
“Can end users look up a single ticket form?”
Tell an agent
Show this ticket form.
Get the details of one ticket form by id.
PUT /api/v2/ticket_forms/{ticket_form_id} Update a ticket form · Zendesk Put Api V2 Ticket_forms Ticket_form_id #
Ask an LLM
“Can I change the name or fields of an existing ticket form?”
“Is it possible to hide a ticket form from end users?”
Tell an agent
Update this ticket form to add a new field.
Rename one ticket form.
DELETE /api/v2/ticket_forms/{ticket_form_id} Delete a ticket form · Zendesk Delete Api V2 Ticket_forms Ticket_form_id #
Ask an LLM
“Can I delete a ticket form I don't use anymore?”
“Who has permission to remove ticket forms?”
Tell an agent destructive · confirm first
Delete this ticket form.
Remove the unused ticket form.
POST /api/v2/ticket_forms/{ticket_form_id}/clone Clone a ticket form · Zendesk Post Api V2 Ticket_forms Ticket_form_id Clone #
Ask an LLM
“Can I duplicate an existing ticket form as a starting point?”
“Is there a way to copy a ticket form?”
Tell an agent
Clone this ticket form.
Make a copy of the existing ticket form.
GET /api/v2/ticket_forms/{ticket_form_id}/ticket_form_statuses List a ticket form's status associations · Zendesk Get Api V2 Ticket_forms Ticket_form_id Ticket_form_statuses #
Ask an LLM
“Which ticket statuses are associated with a ticket form?”
“Can I see the custom statuses linked to one form?”
Tell an agent
List the ticket statuses associated with this form.
Show which statuses are linked to one ticket form.
POST /api/v2/ticket_forms/{ticket_form_id}/ticket_form_statuses Link statuses to a ticket form · Zendesk Post Api V2 Ticket_forms Ticket_form_id Ticket_form_statuses #
Ask an LLM
“How can I associate new ticket statuses with a form?”
“Can I create several form status associations at once?”
Tell an agent
Associate these ticket statuses with the form.
Link new statuses to one ticket form.
PUT /api/v2/ticket_forms/{ticket_form_id}/ticket_form_statuses Bulk update a form's status associations · Zendesk Put Api V2 Ticket_forms Ticket_form_id Ticket_form_statuses #
Ask an LLM
“Can I add and remove status associations on a form in one call?”
“Is there a bulk operation for a ticket form's statuses?”
Tell an agent
Update the status associations for this ticket form in bulk.
Add and remove several statuses on one form at once.
PUT /api/v2/ticket_forms/{ticket_form_id}/ticket_form_statuses/{ticket_form_status_id} Update one form status association · Zendesk Put Api V2 Ticket_forms Ticket_form_id Ticket_form_statuses… #
Ask an LLM
“Can I change or delete a single status association on a form?”
“What's the way to edit one ticket form status link by its id?”
Tell an agent
Update this single ticket form status association.
Change one status link on the form by its association id.
PUT /api/v2/ticket_forms/reorder Reorder ticket forms · Zendesk Put Api V2 Ticket_forms Reorder #
Ask an LLM
“Can I change the order ticket forms appear in?”
“What do I pass to set the ticket form order?”
Tell an agent
Reorder the ticket forms in this sequence.
Put the billing form first in the ticket form order.
GET /api/v2/ticket_forms/show_many Get several ticket forms by id · Zendesk Get Api V2 Ticket_forms Show_many #
Ask an LLM
“Can I fetch up to 100 ticket forms by id in one request?”
“Which endpoint does the web widget use to load several forms?”
Tell an agent
Show the ticket forms {ids}.
Fetch ticket forms {ids} where active is {active}.

Documentation

📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/introduction/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/targets/targets/
📖
Documentation
https://developer.zendesk.com/api-reference/sales-crm/resources/account/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/activity_stream/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/channel_framework/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket-attachments/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/audit_logs/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/organizations/organizations/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/business-rules/automations/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/bookmarks/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/brand_agents/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/brands/
📖
Documentation
https://developer.zendesk.com/api-reference/live-chat/chat-api/chats/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_comments/
📖
Documentation
https://developer.zendesk.com/api-reference/custom-data/introduction/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/custom_roles/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/custom_ticket_statuses/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/users/users/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/business-rules/deletion_schedules/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/dynamic_content/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/email_notifications/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/groups/group_memberships/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/business-rules/group_sla_policies/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/groups/groups/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_import/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/incremental_exports/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/job_statuses/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/locales/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/business-rules/macros/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/oauth/oauth_tokens/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/organizations/organization_fields/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/organizations/organization_memberships/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/organizations/organization_subscriptions/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/push_notification_devices/
📖
Documentation
https://developer.zendesk.com/api-reference/agent-availability/omnichannel_routing_queues/omnichannel_routing_queues/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/support_addresses/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/lookup_relationships/lookup_relationships/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket-requests/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/resource_collections/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/skill_based_routing/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/satisfaction_ratings/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/satisfaction_reasons/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/search/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/account-configuration/sessions/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/sharing_agreements/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_skips/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/business-rules/sla_policies/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/suspended_tickets/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/tags/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_audits/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_fields/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_form_statuses/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_forms/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_metrics/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/business-rules/triggers/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/business-rules/views/
📖
Documentation
https://developer.zendesk.com/api-reference/ticketing/ticket-management/workspaces/

Specifications

Schemas & Data

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/zendesk:zendesk-ticket-forms-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

zendesk-ticket-forms-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: '1.0'
  title: Zendesk Ticket Forms API
  description: Needs a description.
tags:
- name: Ticket Forms
paths:
  /api/v2/ticket_forms:
    get:
      operationId: ListTicketForms
      tags:
      - Ticket Forms
      summary: Zendesk Get Api V2 Ticket_forms
      description: 'Returns a list of all ticket forms for your account if accessed as an admin or agent. End users only see ticket forms that have `end_user_visible` set to true.


        #### Allowed For


        * Anyone'
      parameters:
      - name: active
        in: query
        description: true returns active ticket forms; false returns inactive ticket forms. If not present, returns both
        schema:
          type: boolean
      - name: end_user_visible
        in: query
        description: true returns ticket forms where `end_user_visible`; false returns ticket forms that are not end-user visible. If not present, returns both
        schema:
          type: boolean
      - name: fallback_to_default
        in: query
        description: true returns the default ticket form when the criteria defined by the parameters results in a set without active and end-user visible ticket forms
        schema:
          type: boolean
      - name: associated_to_brand
        in: query
        description: true returns the ticket forms of the brand specified by the url's subdomain
        schema:
          type: boolean
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TicketFormsResponse'
              examples:
                default:
                  $ref: '#/components/examples/TicketFormsResponseExample'
    post:
      operationId: CreateTicketForm
      tags:
      - Ticket Forms
      summary: Zendesk Post Api V2 Ticket_forms
      description: '#### Allowed For


        * Admins'
      responses:
        '201':
          description: Created response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TicketFormResponse'
              examples:
                default:
                  $ref: '#/components/examples/TicketFormCreateResponseExample'
  /api/v2/ticket_forms/{ticket_form_id}:
    parameters:
    - $ref: '#/components/parameters/TicketFormId'
    get:
      operationId: ShowTicketForm
      tags:
      - Ticket Forms
      summary: Zendesk Get Api V2 Ticket_forms Ticket_form_id
      description: '#### Allowed For


        * Admins, Agents, and End Users'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TicketFormResponse'
              examples:
                default:
                  $ref: '#/components/examples/TicketFormResponseExample'
    put:
      operationId: UpdateTicketForm
      tags:
      - Ticket Forms
      summary: Zendesk Put Api V2 Ticket_forms Ticket_form_id
      description: '#### Allowed For

        * Admins'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TicketFormResponse'
              examples:
                default:
                  $ref: '#/components/examples/TicketFormUpdateResponseExample'
    delete:
      operationId: DeleteTicketForm
      tags:
      - Ticket Forms
      summary: Zendesk Delete Api V2 Ticket_forms Ticket_form_id
      description: '#### Allowed For

        * Admins'
      responses:
        '204':
          description: No Content response
  /api/v2/ticket_forms/{ticket_form_id}/clone:
    parameters:
    - $ref: '#/components/parameters/TicketFormId'
    post:
      operationId: CloneTicketForm
      tags:
      - Ticket Forms
      summary: Zendesk Post Api V2 Ticket_forms Ticket_form_id Clone
      description: '#### Allowed For


        * Admins'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TicketFormResponse'
              examples:
                default:
                  $ref: '#/components/examples/TicketFormResponseExample'
  /api/v2/ticket_forms/{ticket_form_id}/ticket_form_statuses:
    parameters:
    - $ref: '#/components/parameters/TicketFormId'
    get:
      operationId: TicketFormTicketFormStatuses
      tags:
      - Ticket Forms
      summary: Zendesk Get Api V2 Ticket_forms Ticket_form_id Ticket_form_statuses
      description: 'Fetches all of the associated ticket form statuses of a ticket form.


        #### Allowed For


        * Admins

        * Agents'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TicketFormStatusesResponse'
              examples:
                default:
                  $ref: '#/components/examples/TicketFormStatusesResponseExample'
    post:
      operationId: CreateTicketFormStatuses
      tags:
      - Ticket Forms
      summary: Zendesk Post Api V2 Ticket_forms Ticket_form_id Ticket_form_statuses
      description: 'Creates one or many ticket form status associations


        #### Allowed For


        * Admins'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TicketFormStatusesParams'
            example:
              ticket_form_status:
              - custom_status_id: 1234
              - custom_status_id: 1235
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TicketFormStatusesResponse'
              examples:
                default:
                  $ref: '#/components/examples/TicketFormStatusesResponseExample'
    put:
      operationId: UpdateTicketFormStatuses
      tags:
      - Ticket Forms
      summary: Zendesk Put Api V2 Ticket_forms Ticket_form_id Ticket_form_statuses
      description: 'Updates or deletes ticket form status associations. This is a bulk operation that can both add and remove ticket form status associations for a form in one call.


        #### Allowed For


        * Admins'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateTicketFormStatusesParams'
            example:
              ticket_form_status:
              - _destroy: '1'
                id: abcdef
              - custom_status_id: 1
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TicketFormStatusesResponse'
              examples:
                default:
                  $ref: '#/components/examples/TicketFormStatusesResponseExample'
  /api/v2/ticket_forms/{ticket_form_id}/ticket_form_statuses/{ticket_form_status_id}:
    parameters:
    - $ref: '#/components/parameters/TicketFormId'
    - $ref: '#/components/parameters/TicketFormStatusId'
    put:
      operationId: UpdateTicketFormStatusById
      tags:
      - Ticket Forms
      summary: Zendesk Put Api V2 Ticket_forms Ticket_form_id Ticket_form_statuses…
      description: 'Updates or deletes ticket form status association by id.


        #### Allowed For


        * Admins'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateTicketFormStatusesParams'
            example:
              ticket_form_status:
              - custom_status_id: 1
              - custom_status_id: 2
              - custom_status_id: 3
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TicketFormStatusesResponse'
              examples:
                default:
                  $ref: '#/components/examples/TicketFormStatusesResponseExample'
  /api/v2/ticket_forms/reorder:
    put:
      operationId: ReorderTicketForms
      tags:
      - Ticket Forms
      summary: Zendesk Put Api V2 Ticket_forms Reorder
      description: '#### Allowed For

        * Admins


        #### Request Parameters


        You can pass in the following parameter in the payload:


        | Name | Type | Comment

        | ------------------- | ------ | --------

        | ticket_form_ids | array | An array of ticket form ids. Example: "[2, 23, 46, 50]"'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TicketFormsResponse'
              examples:
                default:
                  $ref: '#/components/examples/TicketFormsResponseExample'
  /api/v2/ticket_forms/show_many:
    get:
      operationId: ShowManyTicketForms
      tags:
      - Ticket Forms
      summary: Zendesk Get Api V2 Ticket_forms Show_many
      description: 'Takes an `ids` query parameter that accepts a comma-separated list of up to 100 ticket form ids. This endpoint is used primarily by the mobile SDK and the Web Widget.


        #### Allowed For


        * Anyone'
      parameters:
      - name: ids
        in: query
        description: IDs of the ticket forms to be shown
        required: true
        schema:
          type: string
        example: 1,2,3
      - name: active
        in: query
        description: true returns active ticket forms; false returns inactive ticket forms. If not present, returns both
        schema:
          type: boolean
      - name: end_user_visible
        in: query
        description: true returns ticket forms where `end_user_visible`; false returns ticket forms that are not end-user visible. If not present, returns both
        schema:
          type: boolean
      - name: fallback_to_default
        in: query
        description: true returns the default ticket form when the criteria defined by the parameters results in a set without active and end-user visible ticket forms
        schema:
          type: boolean
      - name: associated_to_brand
        in: query
        description: true returns the ticket forms of the brand specified by the url's subdomain
        schema:
          type: boolean
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TicketFormsResponse'
              examples:
                default:
                  $ref: '#/components/examples/TicketFormsResponseExample'
components:
  schemas:
    TicketFormsResponse:
      type: object
      properties:
        ticket_forms:
          type: array
          items:
            $ref: '#/components/schemas/TicketFormObject'
    TicketFormStatusesResponse:
      type: object
      properties:
        ticket_form_statuses:
          type: array
          items:
            $ref: '#/components/schemas/TicketFormStatusObject'
          maxItems: 1
    TicketFormResponse:
      type: object
      properties:
        ticket_form:
          $ref: '#/components/schemas/TicketFormObject'