Skip to main content
GET
List assistant inboxes

Authorizations

api_access_token
string
header
required

Path Parameters

assistant_id
integer
required

ID of the assistant

account_id
integer
required

The numeric ID of the account

Response

Success

id
number

ID of the inbox

name
string

The name of the inbox

website_url
string

Website URL

channel_type
string

The type of the inbox

avatar_url
string

The avatar image of the inbox

widget_color
string

Widget Color used for customization of the widget

website_token
string

Website Token

enable_auto_assignment
boolean

The flag which shows whether Auto Assignment is enabled or not

web_widget_script
string

Script used to load the website widget

welcome_title
string

Welcome title to be displayed on the widget

welcome_tagline
string

Welcome tagline to be displayed on the widget

greeting_enabled
boolean

The flag which shows whether greeting is enabled

greeting_message
string

A greeting message when the user starts the conversation

channel_id
number

ID of the channel this inbox belongs to

working_hours_enabled
boolean

The flag which shows whether working hours feature is enabled

enable_email_collect
boolean

The flag to enable collecting email from contacts

csat_survey_enabled
boolean

The flag to enable CSAT survey

auto_assignment_config
object

Configuration settings for auto assignment

out_of_office_message
string

Message to show when agents are out of office

working_hours
object[]

Configuration for working hours of the inbox

timezone
string

Timezone configuration for the inbox

callback_webhook_url
string

Webhook URL for callbacks

allow_messages_after_resolved
boolean

Whether to allow messages after a conversation is resolved

lock_to_single_conversation
boolean

Whether to lock a contact to a single conversation

sender_name_type
string

Type of sender name to display (e.g., friendly)

business_name
string

Business name associated with the inbox

hmac_mandatory
boolean

Whether HMAC verification is mandatory

selected_feature_flags
object

Selected feature flags for the inbox

reply_time
string

Expected reply time

messaging_service_sid
string

Messaging service SID for SMS providers

phone_number
string

Phone number associated with the inbox

medium
string

Medium of communication (e.g., sms, email)

provider
string

Provider of the channel