Skip to main content
GET
List inbox chats

Authorizations

Authorization
string
header
required

Bearer token authentication using your API key

Query Parameters

Search by contact name, email, phone or chat title

Maximum string length: 256
assistant_id
string

Only conversations handled by this assistant.

Maximum string length: 128
assistant_channel_id
string
Maximum string length: 128
conversation_id
string
Maximum string length: 128
contact_id
string

Only conversations with this contact.

Maximum string length: 128
segment_id
string

Only conversations with contacts in this segment.

Maximum string length: 128
assigned_user_id
string

Only conversations assigned to this member.

Maximum string length: 128
status
enum<string>
Available options:
ALL,
RUNNING,
COMPLETED,
FAILED,
CANCELED
state
enum<string>
Available options:
ALL,
OPEN,
CLOSED
ai_status
enum<string>
Available options:
ALL,
ENABLED,
DISABLED
filter
enum<string>

UNREAD: has messages the team has not seen. WAITING: open, unassigned and the AI not replying. UNRESOLVED: open conversations. RESOLVED: closed. ASSIGNED_TO_ME: assigned to the current user. UNASSIGNED: nobody assigned.

Available options:
ALL,
UNREAD,
WAITING,
UNRESOLVED,
RESOLVED,
ASSIGNED_TO_ME,
UNASSIGNED
referral_type
enum<string>
Available options:
ALL,
messenger_ad,
messenger_product,
messenger_product_template,
whatsapp_ad,
whatsapp_product,
whatsapp_order,
instagram_ad,
instagram_product,
instagram_product_template,
instagram_post,
instagram_reel,
instagram_story,
instagram_story_mention,
instagram_comment,
messenger_post,
messenger_reel,
messenger_comment,
tiktok_ad,
tiktok_post_share,
tiktok_short_link,
web_widget
csat_max
enum<string>

Only conversations with a CSAT score at or below this value (find unhappy customers); 0 means no filter.

Available options:
0,
1,
2,
3,
4,
5
from_date
string<date-time> | null

Only conversations with activity (a message or a change) on or after this date (ISO 8601). Omit for all time.

to_date
string<date-time> | null

Only conversations whose last activity is on or before this date (ISO 8601). Omit for up to now.

page
number

Page number

take
number

Number of items to take

next
string

Next page token (Only used on special endpoints)

Response

200 - application/json
id
string
required
title
string | null
required

The title of the chat

model
string
required

The model used for the chat

members
object[]
required

The members of the chat

temporary
boolean
required

Whether the chat is temporary and would be deleted after 24 hours of last activity

visibility
enum<string>
required

The visibility of the chat

Available options:
PRIVATE,
PUBLIC_READ,
PUBLIC_WRITE
pinned
boolean
required

Whether the chat is pinned in the user interface

status
enum<string>
required

The status of the chat

Available options:
RUNNING,
COMPLETED,
FAILED,
CANCELED
shared_url
string | null
required

The shared URL of the chat, if it is shared

created_at
string<date-time> | null
required
updated_at
string<date-time> | null
required
tools
object[]

The tools available in the chat

skills
object[]

The skills enabled in the chat

features
object

Per-chat features and run settings: model features plus approval mode and org-chat tool toggles.

org_id
string
agent
object

The agent whose run this chat is

routine
object

The routine whose fire started this chat

activity
object

Compact activity reference: its id and the contact or custom-table record it was written on, drawn like their mention chips

state
object

Schema for the chat state

The link to the chat in the integration

last_message
object

The chat message schema

referral
object

Referral/commerce event data from Meta platforms — ads, products, orders.

reminders
object[]

The active reminders scheduled on this chat

attentions
object[]

The pending approvals and questions waiting on this chat

spend
number

What the organization paid for this chat's AI turns, in USD; org chats only