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

# Search conversations

> Matches the customer's name, number or email, the agent, the channel, the summary, topic and outcome — what the Conversations page's search box matches. One request reads at most 1,000 conversations; if it stops there, `has_more` is true and `next_cursor` carries on from where it stopped, even when `data` is empty.



## OpenAPI

````yaml /api-reference/openapi.json get /conversations/search
openapi: 3.1.0
info:
  title: Wiredesk API
  version: 1.0.0
  description: >-
    Read and change a Wiredesk workspace: agents, conversations, contacts, leads
    and knowledge, and talk to an agent. Authenticate with an API key from
    Developers → API keys. Every response carries an x-request-id header, which
    Developers → Logs finds the request by.
servers:
  - url: https://wiredesk.ai/api/v1
security:
  - bearerAuth: []
tags:
  - name: Agents
    description: 'The workspace''s agents: their name, greeting, instructions and channels.'
  - name: Chat
    description: >-
      Send a customer's message to an agent and get its reply, without the chat
      widget.
  - name: Knowledge
    description: >-
      What an agent answers from: pasted text and websites, and the sources
      added in the dashboard.
  - name: Conversations
    description: Conversations on every channel, and their transcripts.
  - name: Contacts
    description: The people the agents talk to, by phone number, email or your own id.
  - name: Leads
    description: Leads the agents captured.
  - name: Onboarding
    description: >-
      Agent-first onboarding: an AI agent builds a trial agent from a website,
      and a person claims it.
paths:
  /conversations/search:
    get:
      tags:
        - Conversations
      summary: Search conversations
      description: >-
        Matches the customer's name, number or email, the agent, the channel,
        the summary, topic and outcome — what the Conversations page's search
        box matches. One request reads at most 1,000 conversations; if it stops
        there, `has_more` is true and `next_cursor` carries on from where it
        stopped, even when `data` is empty.
      operationId: search_conversations
      parameters:
        - name: q
          in: query
          required: true
          schema:
            type: string
            maxLength: 200
          description: What to look for.
        - name: agent_id
          in: query
          required: false
          schema:
            type: string
          description: Only this agent's.
        - name: channel
          in: query
          required: false
          schema:
            type: string
            enum:
              - chat
              - phone
              - email
              - web_voice
              - whatsapp
              - zendesk_messaging
          description: Only this channel.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 20
          description: Page size.
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: '`next_cursor` from the previous page.'
      responses:
        '200':
          description: A page of matches
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - next_cursor
                  - has_more
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Conversation'
                  next_cursor:
                    anyOf:
                      - type: string
                      - type: 'null'
                  has_more:
                    type: boolean
          headers:
            x-request-id:
              $ref: '#/components/headers/RequestId'
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            x-request-id:
              $ref: '#/components/headers/RequestId'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            x-request-id:
              $ref: '#/components/headers/RequestId'
        '429':
          description: Rate limited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            x-request-id:
              $ref: '#/components/headers/RequestId'
components:
  schemas:
    Conversation:
      type: object
      properties:
        id:
          type: string
        object:
          type: string
          const: conversation
        agent_id:
          anyOf:
            - type: string
            - type: 'null'
        channel:
          type: string
          enum:
            - chat
            - phone
            - email
            - web_voice
            - whatsapp
            - zendesk_messaging
        contact:
          $ref: '#/components/schemas/ConversationContact'
        status:
          type: string
          enum:
            - live
            - ended
        started_at:
          type: string
          format: date-time
        ended_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
        outcome:
          anyOf:
            - type: string
              enum:
                - resolved
                - handed_over
                - message_taken
                - abandoned
            - type: 'null'
        summary:
          anyOf:
            - type: string
            - type: 'null'
        topic:
          anyOf:
            - type: string
            - type: 'null'
        sentiment:
          anyOf:
            - type: string
              enum:
                - positive
                - neutral
                - negative
            - type: 'null'
        handover_state:
          anyOf:
            - type: string
              enum:
                - requested
                - active
                - unanswered
            - type: 'null'
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              enum:
                - invalid_request
                - unauthorized
                - spend_cap_reached
                - read_only_key
                - channel_disabled
                - knowledge_full
                - not_found
                - method_not_allowed
                - already_exists
                - conflict
                - rate_limited
                - internal_error
                - upstream_error
                - not_configured
            message:
              type: string
          additionalProperties: true
    ConversationContact:
      type: object
      properties:
        id:
          anyOf:
            - type: string
            - type: 'null'
        kind:
          type: string
          enum:
            - phone
            - email
            - visitor
            - api
            - user
        value:
          type: string
        name:
          anyOf:
            - type: string
            - type: 'null'
  headers:
    RequestId:
      description: >-
        A unique id for this request, on every response including errors.
        Developers → Logs finds the request by it; quote it to support.
      schema:
        type: string
        format: uuid
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: An API key, `wd_...`.

````

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