# Filter tickets

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

Group: Tickets. Page: https://www.nabrah.ai/en/docs/api-reference/tickets/filter-tickets

Lists tickets using a structured server-side filter supplied in the request body, returning the same `meta`/`payload` shape as the generic list endpoint. Pass an array of filter objects under `filters`; results are paged with the `page` query parameter. Use this instead of GET /ticket when you need precise, composable filtering beyond the simple `assignee_type`/`status`/`q` query parameters.

## Filter body

- **filters[]**: An array of filter condition objects combined to narrow the result set. Each object expresses a condition on a ticket attribute (such as status, priority, assignee, labels, or inbox). An empty object (`{}`) applies no constraint and returns all tickets in the project. Fields: `filters`.

Build filter values from ids you discover elsewhere: inbox_id from GET /ticket/inboxes, contact ids from GET /api/ext/omni_v2/contact.

## Pagination

- **page**: 1-based page number passed as a query parameter (the filter itself goes in the body). Increment until `payload` is empty.

## Response

Same ListTicketsResponse shape as GET /api/ext/omni_v2/ticket: `meta` bucket counts plus a `payload` array of ticket summaries.

## Authorization

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

## Query parameters

- `page` (integer, optional): 1-based page number for pagination. Optional; defaults to the first page. The filter criteria are sent in the request body, not the query string.

## Body (application/json)

### Example: All tickets

Empty filter — returns all tickets in the project.

```json
{
  "filters": [
    {}
  ]
}
```

## 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"
      },
      "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
        }
      ],
      "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/ticket/filter' \
  --header 'X-API-Key: <your-api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "filters": [
    {}
  ]
}'
```

### Python

```python
import requests

url = "https://api.nabrah.ai/api/ext/omni_v2/ticket/filter"
headers = {
    "X-API-Key": "<your-api-key>",
}
payload = {
    "filters": [
        {}
    ]
}

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/ticket/filter", {
  method: "POST",
  headers: {
    "X-API-Key": "<your-api-key>",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "filters": [
      {}
    ]
  }),
});

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

### Go

```go
package main

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

func main() {
	payload := strings.NewReader(`{
  "filters": [
    {}
  ]
}`)

	req, _ := http.NewRequest("POST", "https://api.nabrah.ai/api/ext/omni_v2/ticket/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))
}
```
