Zendesk Problems API

The Zendesk Problems API helps you manage problem tickets and their relationship to incident tickets, so you can track and resolve widespread issues affecting multiple customers. It provides endpoints to list and query problem tickets and to retrieve the incidents linked to a specific problem (for example, to understand scope and impact).

OpenAPI Specification

problems-openapi-original.yml Raw ↑
openapi: 3.1.0
info:
  version: "1.0"
  title: Zendesk Problems
  description: Needs a description.
paths:
  /api/v2/problems:
    get:
      operationId: ListTicketProblems
      tags:
        - Tickets
      summary: Zendesk Get  Api V2 Problems
      description: |-
        The response is always ordered by `updated_at` in descending order

        #### Allowed For

        * Agents

        #### Pagination

        * Cursor pagination (recommended)
        * Offset pagination

        See [Pagination](/api-reference/introduction/pagination/).
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListTicketProblemsResponse'
              examples:
                default:
                  $ref: '#/components/examples/ListTicketProblemsResponseExample'
  /api/v2/problems/autocomplete:
    post:
      operationId: AutocompleteProblems
      tags:
        - Tickets
      summary: Zendesk Post  Api V2 Problems Autocomplete
      description: >-
        Returns tickets whose type is "problem" and whose subject contains the
        string specified in the `text` parameter.


        You can specify the `text` parameter in the request body rather than the
        query string. Example:


        `{"text": "fire"}`


        #### Allowed For


        * Agents
      parameters:
        - name: text
          in: query
          description: The text to search for
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                text:
                  type: string
                  description: The text to search for
            example:
              text: fire
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListTicketProblemsResponse'
              examples:
                default:
                  $ref: '#/components/examples/ListTicketProblemsResponseExample'
components:
  schemas:
    ListTicketProblemsResponse:
      type: object
      additionalProperties: true
tags:
  - name: Tickets