---
title: "Search this workspace’s Hive Inbox conversations and return each one’s id, account, status, who it is assigned to and when it last moved. Contact names and message text are returned only while the workspace allows outside AI to read them, and always redacted."
method: POST
path: "/api/v1/tools/search_inbox"
---

# Search this workspace’s Hive Inbox conversations and return each one’s id, account, status, who it is assigned to and when it last moved. Contact names and message text are returned only while the workspace allows outside AI to read them, and always redacted.

`POST /api/v1/tools/search_inbox`

## Request

- Base URL: `https://hivepublish.com`
- URL: `https://hivepublish.com/api/v1/tools/search_inbox`
- Auth: HTTP bearer

## Request body

- object
  - `query` string: Words to look for. Leave it out to list the most recent conversations.
  - `status` 'open' | 'done': Only open conversations, or only resolved ones.
  - `kind` 'dm' | 'comment' | 'mention': Which kind of conversation this is: dm, comment or mention.
  - `channelIds` string[]: Only these connected accounts.
  - `limit` integer: How many conversations to return, from 1 to 50.

## Response `200`

Tool result

- ToolResult
  - `data` unknown, required
  - `meta` object, required
    - `tool` string
    - `workspaceId` string, uuid

## Other responses

- `400`: Invalid input
- `401`: Missing or invalid credential
- `403`: Missing workspace scope, role permission, or plan entitlement
- `409`: Idempotency conflict, replay, or request still in progress
- `429`: Rate limit exceeded

---

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