> ## Documentation Index
> Fetch the complete documentation index at: https://docs.shortext.ny-corp.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Search a ticket



## OpenAPI

````yaml /api-reference/v1.0/openapi.json get /ticket/search
openapi: 3.1.0
info:
  title: Shortext API
  description: >-
    Shortext API v1.0 (legacy). New integrations should use v2.0. Every response
    is HTTP 200: check `success` and `code`, except beyond the rate limit (300
    requests per minute per company, shared with v2.0): HTTP 429 with
    `Retry-After`.
  version: '1.0'
servers:
  - url: https://shortext.ny-corp.io/api
security: []
tags:
  - name: Agents
    description: Agents
  - name: Business manager
    description: Business manager
  - name: Messages
    description: Messages
  - name: Tickets
    description: Tickets
  - name: Knowledge
    description: Knowledge
  - name: Health
    description: Health
paths:
  /ticket/search:
    get:
      tags:
        - Tickets
      summary: Search a ticket
      operationId: searchTicket
      parameters:
        - name: code
          in: query
          required: false
          schema:
            type: string
          example: STT-XLWY6P
        - name: agent
          in: query
          required: false
          schema:
            type: string
          example: AGI-XLWY6P
        - name: status
          in: query
          required: false
          schema:
            description: Use code value from status to filter tickets by status
            type: string
          examples:
            only:
              summary: Use to filter only result with this value
              value: open
            exclude:
              summary: Use <strong>!</strong> to exclude results with this value
              value: '!open'
            multiple:
              summary: >-
                Use <strong>,</strong> to set multiple value each value can have
                or not the <strong>!</strong> exclude mark
              value: '!open,closed'
        - name: priority
          in: query
          required: false
          schema:
            description: Use code value from status to filter tickets by SLA priority
            type: string
          examples:
            only:
              summary: Use to filter only result with this value
              value: medium
            exclude:
              summary: Use <strong>!</strong> to exclude results with this value
              value: '!medium'
            multiple:
              summary: >-
                Use <strong>,</strong> to set multiple value each value can have
                or not the <strong>!</strong> exclude mark
              value: '!medium,low'
      responses:
        '200':
          description: The data
          content:
            application/json:
              schema: {}
              example:
                - id: 62
                  app_id: 1
                  contact_detail_id: 2728
                  whatsapp_session_id: 6023
                  ticket_status_id: 7
                  position: 1
                  subject: >-
                    Problème technique lors de la recherche d'offres en
                    marketing et commerce
                  description: >-
                    L'utilisateur Angèle recherche des opportunités en marketing
                    et commerce, mais un problème technique (timeout lors de la
                    recherche) empêche de fournir les résultats. Une assistance
                    est nécessaire pour résoudre ce problème et fournir des
                    offres pertinentes.
                  ticket_sla_policy_id: 5
                  responded_at: null
                  response_due_at: '2025-05-19T08:00:21.000000Z'
                  resolved_at: null
                  resolved_due_at: '2025-05-19T15:00:22.000000Z'
                  closed_at: null
                  is_response_breached: true
                  is_resolve_breached: true
                  satisfaction_requested: false
                  satisfaction_rating: null
                  meta: null
                  created_at: '2025-05-16T19:02:22.000000Z'
                  updated_at: '2025-09-10T15:16:42.000000Z'
                  hashid: STT-XLWY6P
                  ticket_status:
                    id: 7
                    name: Resolved
                    code: resolved
                  ticket_sla_policy:
                    id: 5
                    label: Medium
                    priority: medium
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      description: >-
        Company API key, sent as `Authorization: Bearer <key>`. Create it in the
        dashboard (Developer > API Keys) with the permissions the integration
        needs.
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.