Skip to main content
GET
/
api
/
v1
/
accounts
/
{account_id}
/
inboxes
/
{id}
/
Get an inbox
curl --request GET \
  --url https://app.chatwoot.com/api/v1/accounts/{account_id}/inboxes/{id}/ \
  --header 'api_access_token: <api-key>'
{
  "id": 123,
  "name": "<string>",
  "website_url": "<string>",
  "channel_type": "<string>",
  "avatar_url": "<string>",
  "widget_color": "<string>",
  "website_token": "<string>",
  "enable_auto_assignment": true,
  "web_widget_script": "<string>",
  "welcome_title": "<string>",
  "welcome_tagline": "<string>",
  "greeting_enabled": true,
  "greeting_message": "<string>",
  "channel_id": 123,
  "working_hours_enabled": true,
  "enable_email_collect": true,
  "csat_survey_enabled": true,
  "auto_assignment_config": {},
  "out_of_office_message": "<string>",
  "working_hours": [
    {
      "day_of_week": 123,
      "closed_all_day": true,
      "open_hour": 123,
      "open_minutes": 123,
      "close_hour": 123,
      "close_minutes": 123,
      "open_all_day": true
    }
  ],
  "timezone": "<string>",
  "callback_webhook_url": "<string>",
  "allow_messages_after_resolved": true,
  "lock_to_single_conversation": true,
  "sender_name_type": "<string>",
  "business_name": "<string>",
  "hmac_mandatory": true,
  "selected_feature_flags": {},
  "reply_time": "<string>",
  "messaging_service_sid": "<string>",
  "phone_number": "<string>",
  "medium": "<string>",
  "provider": "<string>"
}

Authorizations

​
api_access_token
string
header
required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Path Parameters

​
account_id
integer
required

The numeric ID of the account

​
id
number
required

ID of the inbox

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

⌘I