# Filter conversations

> POST https://api.nabrah.ai/api/ext/omni_v2/conversation/conversation/filter

Group: Conversations. Page: https://www.nabrah.ai/en/docs/api-reference/conversations/filter-conversations

Lists conversations matching a structured filter expression supplied in the JSON body, returning the same response shape as the generic list endpoint (`meta` folder counts plus a `payload` array of conversation summaries). Use this when the simple `assignee_type`/`status_param`/`q` query filters are not expressive enough — the body's `filters` array lets you combine multiple attribute conditions. Results are paginated with the `page` query parameter.

## Filter body

The request body wraps an array of filter conditions.

- **filters**: An array of filter condition objects. Each entry expresses a condition on a conversation attribute (such as status, assignee, priority, labels, or inbox); combine multiple entries to narrow results. An empty object matches broadly — provide concrete conditions to filter. Fields: `filters`.

The response payload is identical in shape to GET /api/ext/omni_v2/conversation/conversation.

## Pagination

## Authorization

- `X-API-Key` (string, header, required): your workspace API key.

## Query parameters

- `page` (integer, optional): 1-based page number for pagination. Defaults to the first page when omitted. Page size is server-defined.

## Body (application/json)

### Example: Filter conversations

Provide one or more filter conditions in the `filters` array to scope the conversation list.

```json
{
  "filters": [
    {
      "attribute_key": "status",
      "filter_operator": "equal_to",
      "values": [
        "open"
      ]
    },
    {
      "attribute_key": "priority",
      "filter_operator": "equal_to",
      "values": [
        "urgent"
      ]
    }
  ]
}
```

## Response

### 200 Successful Response

Content type: `application/json`

```json
{
  "meta": {
    "all_count": 0,
    "mine_count": 0,
    "unassigned_count": 0,
    "assigned_count": 0
  },
  "payload": [
    {
      "account_id": 0,
      "additional_attributes": {},
      "agent_last_seen_at": 0,
      "assignee_last_seen_at": 0,
      "can_reply": false,
      "contact_last_seen_at": 0,
      "created_at": 0,
      "custom_attributes": {},
      "first_reply_created_at": 0,
      "id": 0,
      "inbox_id": 0,
      "labels": [
        "string"
      ],
      "last_activity_at": 0,
      "last_non_activity_message": {
        "account_id": 0,
        "additional_attributes": {},
        "content": "string",
        "content_attributes": {},
        "content_type": "string",
        "conversation": null,
        "conversation_id": 0,
        "created_at": 0,
        "external_source_ids": {},
        "id": 0,
        "inbox_id": 0,
        "message_type": 0,
        "private": false,
        "processed_message_content": "string",
        "sender": null,
        "sender_id": 0,
        "sender_type": "string",
        "sentiment": {},
        "source_id": "string",
        "status": "string",
        "updated_at": "string",
        "attachments": []
      },
      "messages": [
        {
          "account_id": null,
          "additional_attributes": null,
          "content": null,
          "content_attributes": null,
          "content_type": null,
          "conversation": null,
          "conversation_id": null,
          "created_at": null,
          "external_source_ids": null,
          "id": null,
          "inbox_id": null,
          "message_type": null,
          "private": null,
          "processed_message_content": null,
          "sender": null,
          "sender_id": null,
          "sender_type": null,
          "sentiment": null,
          "source_id": null,
          "status": null,
          "updated_at": null,
          "attachments": null
        }
      ],
      "meta": {
        "channel": "string",
        "hmac_verified": false,
        "sender": null,
        "assignee": null
      },
      "muted": false,
      "priority": "string",
      "sla_policy_id": 0,
      "snoozed_until": 0,
      "status": "string",
      "timestamp": 0,
      "unread_count": 0,
      "updated_at": 0
    }
  ]
}
```

### 422 Validation Error

Content type: `application/json`

```json
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
```

## Request examples

### cURL

```bash
curl --request POST \
  --url 'https://api.nabrah.ai/api/ext/omni_v2/conversation/conversation/filter' \
  --header 'X-API-Key: <your-api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "filters": [
    {
      "attribute_key": "status",
      "filter_operator": "equal_to",
      "values": [
        "open"
      ]
    },
    {
      "attribute_key": "priority",
      "filter_operator": "equal_to",
      "values": [
        "urgent"
      ]
    }
  ]
}'
```

### Python

```python
import requests

url = "https://api.nabrah.ai/api/ext/omni_v2/conversation/conversation/filter"
headers = {
    "X-API-Key": "<your-api-key>",
}
payload = {
    "filters": [
        {
            "attribute_key": "status",
            "filter_operator": "equal_to",
            "values": [
                "open"
            ]
        },
        {
            "attribute_key": "priority",
            "filter_operator": "equal_to",
            "values": [
                "urgent"
            ]
        }
    ]
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())
```

### JavaScript

```javascript
const response = await fetch("https://api.nabrah.ai/api/ext/omni_v2/conversation/conversation/filter", {
  method: "POST",
  headers: {
    "X-API-Key": "<your-api-key>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "filters": [
      {
        "attribute_key": "status",
        "filter_operator": "equal_to",
        "values": [
          "open"
        ]
      },
      {
        "attribute_key": "priority",
        "filter_operator": "equal_to",
        "values": [
          "urgent"
        ]
      }
    ]
  }),
});

const data = await response.json();
console.log(data);
```

### Go

```go
package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	payload := strings.NewReader(`{
  "filters": [
    {
      "attribute_key": "status",
      "filter_operator": "equal_to",
      "values": [
        "open"
      ]
    },
    {
      "attribute_key": "priority",
      "filter_operator": "equal_to",
      "values": [
        "urgent"
      ]
    }
  ]
}`)

	req, _ := http.NewRequest("POST", "https://api.nabrah.ai/api/ext/omni_v2/conversation/conversation/filter", payload)
	req.Header.Set("X-API-Key", "<your-api-key>")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	out, _ := io.ReadAll(res.Body)
	fmt.Println(string(out))
}
```