---
title: "Search Inbox Chats"
method: POST
path: "/inbox/chats/search"
tags: ["Inbox"]
---

# Search Inbox Chats

`POST /inbox/chats/search`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/inbox/chats/search`
- Auth: HTTP bearer

Search and page the chat inbox.

A POST because the filter is a body, not because it writes anything.

`exclude_tag_ids` is the field that makes a Focused view work: the app
sends the archived / deleted / warmup / bounced tags there. Omit it and
those threads come back.

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Request body

- ChatSearchRequest: Filter and page the chat inbox.
  - `user_id` string, nullable: Restrict to one user's chats.
  - `page` integer
  - `page_size` integer
  - `updated_after` string, date-time, nullable
  - `updated_before` string, date-time, nullable
  - `sort_order` 'asc' | 'desc'
  - `sort_by` 'updated_at' | 'created_at' | 'last_message_at': Field to sort by. See `SortByField` for the accepted values.
  - `tags` string[], nullable: Keep chats carrying ANY of these tag ids.
  - `exclude_tag_ids` string[], nullable: Drop chats carrying ANY of these tag ids. This is what makes a Focused view work - the app sends the archived/deleted/warmup/bounced tags here. Without it those threads come back.

## Response `200`

Successful Response

- ApiResponseInboxPage
  - `data` InboxPage, required: A page of threads, or one thread, exactly as the inbox returns it.
    - `items` object[]
    - `total` integer
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

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