Inbox

Search Inbox Chats

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.

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

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

user_idstring nullable

Restrict to one user's chats.

pageinteger
page_sizeinteger
updated_afterstring date-time nullable
updated_beforestring 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.

tagsstring[] nullable

Keep chats carrying ANY of these tag ids.

exclude_tag_idsstring[] 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

Successful Response

Changes

No recorded changes to this operation across all 2 revisions of this API.