Skip to content

Search Inbox Chats

POST
/inbox/chats/search

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.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body

Filter and page the chat inbox.

object
exclude_tag_ids
Any of:
Array<string>
page
integer
default: 1 >= 1
page_size
integer
default: 20 >= 1 <= 100
sort_by

Field to sort by. See SortByField for the accepted values.

string
default: created_at
Allowed values: updated_at created_at last_message_at
sort_order
string
default: desc
Allowed values: asc desc
tags
Any of:
Array<string>
updated_after
Any of:
string format: date-time
updated_before
Any of:
string format: date-time
user_id
Any of:
string

Responses

200

Successful Response

object
data
required

A page of threads, or one thread, exactly as the inbox returns it.

object
items
Array<object>
object
key
additional properties
any
total
integer
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string