---
title: "Search messages"
method: GET
path: "/v1/search"
tags: ["Search"]
---

# Search messages

`GET /v1/search`

## Request

- Base URL: `https://api.agentboxd.com`
- URL: `https://api.agentboxd.com/v1/search`
- Auth: HTTP bearer

Postgres full-text search with web-search syntax (`"exact phrase"`, `-exclude`, `or`), ranked, with a `snippet`.

Permission: `search`.

## Query parameters

- `include_unscreened` 'true' | 'false'
- `include_held` 'true' | 'false'
- `q` string, required
- `inbox_id` string, uuid
- `cursor` string
- `limit` integer
- `include_blocked` 'true' | 'false'
- `channel` 'agent' | 'email' | 'mixed'
- `type` 'message' | 'task' | 'event'

## Response `200`

OK

- object

## Other responses

- `4XX`: Error
- `5XX`: Error

---

[API](https://skmtc.dev/agentboxd/apis/agentboxd-api.md) · [All operations](https://skmtc.dev/agentboxd/apis/agentboxd-api/llms.txt) · [OpenAPI document](https://skmtc.dev/agentboxd/apis/agentboxd-api/revisions/ee7b079f0e97?raw)