---
title: "Search conversations with filters"
method: POST
path: "/beta/search/conversations"
tags: ["Search", "Conversations"]
---

# Search conversations with filters

`POST /beta/search/conversations`

Search for conversations containing a particular text or by filter or combine them both

## Query parameters

- `pageLimit` integer
- `pageKey` string

## Request body

- SearchParametersInput
  - `query` Query
    - `value` string, required
    - `exactMatch` boolean
  - `filters` Filters
    - `strategy` string, required — values: [All, Any]
    - `conditions` Condition[]
      - `field` union, required
        - AgentId
          - `operator` union, required
            - IsEmpty
            - IsNotEmpty
            - IsNotOneOf
              - …
            - IsOneOf
              - …
        - AssignedDate
          - `operator` union, required
            - Between — Timestamps in ISO-8601 format: yyyy-MM-dd'T'HH:mm:ss'Z'
              - …
            - Since — Timestamp in ISO-8601 format: yyyy-MM-dd'T'HH:mm:ss'Z'
              - …
            - Until — Timestamp in ISO-8601 format: yyyy-MM-dd'T'HH:mm:ss'Z'
              - …
        - Channel
          - `operator` union, required
            - IsNotOneOf1
              - …
            - IsOneOf1
              - …
        - ClosedDate
          - `operator` union, required
            - Between — Timestamps in ISO-8601 format: yyyy-MM-dd'T'HH:mm:ss'Z'
              - …
            - Since — Timestamp in ISO-8601 format: yyyy-MM-dd'T'HH:mm:ss'Z'
              - …
            - Until — Timestamp in ISO-8601 format: yyyy-MM-dd'T'HH:mm:ss'Z'
              - …
        - ContactId
          - `operator` union, required
            - IsNotOneOf
              - …
            - IsOneOf
              - …
        - ConversationId
          - `operator` union, required
            - IsNotOneOf
              - …
            - IsOneOf
              - …
        - CreationDate
          - `operator` union, required
            - Between — Timestamps in ISO-8601 format: yyyy-MM-dd'T'HH:mm:ss'Z'
              - …
            - Since — Timestamp in ISO-8601 format: yyyy-MM-dd'T'HH:mm:ss'Z'
              - …
            - Until — Timestamp in ISO-8601 format: yyyy-MM-dd'T'HH:mm:ss'Z'
              - …
        - CustomAttribute1
          - `operator` union, required
            - IsEmpty
            - IsNotEmpty
            - IsNotOneOf2
              - …
            - IsOneOf2
              - …
          - `attributeId` string, required
        - Direction
          - `operator` union, required
            - IsNotOneOf3
              - …
            - IsOneOf3
              - …
        - Duration
          - `operator` union, required
            - Between1 — min and max in milliseconds; for example: '10800000' (3 hours)
              - …
            - LongerThanOrEqualTo — In milliseconds; for example: '10800000' (3 hours)
              - …
            - ShorterThanOrEqualTo — In milliseconds; for example: '10800000' (3 hours)
              - …
        - LastActivity
          - `operator` union, required
            - Between — Timestamps in ISO-8601 format: yyyy-MM-dd'T'HH:mm:ss'Z'
              - …
            - Since — Timestamp in ISO-8601 format: yyyy-MM-dd'T'HH:mm:ss'Z'
              - …
            - Until — Timestamp in ISO-8601 format: yyyy-MM-dd'T'HH:mm:ss'Z'
              - …
        - LastMessage
          - `operator` union, required
            - Between — Timestamps in ISO-8601 format: yyyy-MM-dd'T'HH:mm:ss'Z'
              - …
            - Since — Timestamp in ISO-8601 format: yyyy-MM-dd'T'HH:mm:ss'Z'
              - …
            - Until — Timestamp in ISO-8601 format: yyyy-MM-dd'T'HH:mm:ss'Z'
              - …
        - QueueId
          - `operator` union, required
            - IsEmpty
            - IsNotEmpty
            - IsNotOneOf
              - …
            - IsOneOf
              - …
        - Status1
          - `operator` union, required
            - IsNotOneOf4
              - …
            - IsOneOf4
              - …
        - TagId
          - `operator` union, required
            - ExcludesAll
              - …
            - ExcludesOne
              - …
            - IncludesAll
              - …
            - IncludesOne
              - …
            - IsEmpty
            - IsNotEmpty

## Response `200`

The search results for the searched parameters

- SearchConversationsWithFiltersOutput
  - `data` ConversationSearchWithFiltersHit[]
    - `id` integer, required — Identifier of a Conversation where a match was found
    - `highlights` MapVectorString, required — Snippet of text where a match was found. Matched text will be wrapped in \<em\> tags.
  - `meta` PaginationLinks
    - `previous` string — url
    - `next` string — url

## Other responses

- `400` — Invalid value extracted from request context, Invalid value for: query parameter pageLimit, Invalid value for: query parameter pageKey, Invalid value for: body
- `401` — The user who issued the access token used in the request is not authorized to perform the operation
- `500` — Internal failure during request processing

---

[API](https://skmtc.net/dixa/apis/dixa-api.md) · [All operations](https://skmtc.net/dixa/apis/dixa-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/dixa/dixa-api/revisions/5eaff14a2c46/schema)