Skip to main content
GET
/
public
/
api
/
v1
/
inboxes
/
{inbox_identifier}
Inbox details
curl --request GET \
  --url https://app.chatwoot.com/public/api/v1/inboxes/{inbox_identifier}
{
  "identifier": "<string>",
  "name": "<string>",
  "timezone": "<string>",
  "working_hours": [
    {
      "day_of_week": 123,
      "open_all_day": true,
      "closed_all_day": true,
      "open_hour": 123,
      "open_minutes": 123,
      "close_hour": 123,
      "close_minutes": 123
    }
  ],
  "working_hours_enabled": true,
  "csat_survey_enabled": true,
  "greeting_enabled": true,
  "identity_validation_enabled": true
}

Path Parameters

​
inbox_identifier
string
required

The identifier obtained from API inbox channel

Response

Success

​
identifier
string

Inbox identifier

​
name
string

Name of the inbox

​
timezone
string

The timezone defined on the inbox

​
working_hours
object[]

The working hours defined on the inbox

​
working_hours_enabled
boolean

Whether of not the working hours are enabled on the inbox

​
csat_survey_enabled
boolean

Whether of not the Customer Satisfaction survey is enabled on the inbox

​
greeting_enabled
boolean

Whether of not the Greeting Message is enabled on the inbox

​
identity_validation_enabled
boolean

Whether of not the User Identity Validation is enforced on the inbox