Inbox

List inbox chats

Get a list of inbox chats for a specific org.

get/orgs/inbox

Request

  • Base URL: https://api.useinvent.com
  • URL: https://api.useinvent.com/orgs/inbox
  • Auth: HTTP bearer

Query parameters

searchstring

Search by contact name, email, phone or chat title

assistant_idstring

Only conversations handled by this assistant.

assistant_channel_idstring
conversation_idstring
contact_idstring

Only conversations with this contact.

segment_idstring

Only conversations with contacts in this segment.

assigned_user_idstring

Only conversations assigned to this member.

status'ALL' | 'RUNNING' | 'COMPLETED' | 'FAILED' | 'CANCELED'
state'ALL' | 'OPEN' | 'CLOSED'
ai_status'ALL' | 'ENABLED' | 'DISABLED'
filter'ALL' | 'UNREAD' | 'WAITING' | 'UNRESOLVED' | 'RESOLVED' | 'ASSIGNED_TO_ME' | 'UNASSIGNED'

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.

referral_type'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'0' | '1' | '2' | '3' | '4' | '5'

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

from_datestring date-time nullable

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

to_datestring date-time nullable

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

pagenumber

Page number

takenumber

Number of items to take

nextstring

Next page token (Only used on special endpoints)

progressiveboolean

Skip the total count: pagination-count is exact on the last page, and one more than the items so far while more pages exist (Only used on special endpoints)

Response

idstring required
titlestring nullable required

The title of the chat

modelstring required

The model used for the chat

org_idstring
temporaryboolean required

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

visibility'PRIVATE' | 'PUBLIC_READ' | 'PUBLIC_WRITE' required

The visibility of the chat

pinnedboolean required

Whether the chat is pinned in the user interface

status'RUNNING' | 'COMPLETED' | 'FAILED' | 'CANCELED' required

The status of the chat

linkstring

The link to the chat in the integration

shared_urlstring nullable required

The shared URL of the chat, if it is shared

spendnumber

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

created_atstring date-time nullable required
updated_atstring date-time nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.