Getting Started
Application APIs
Platform APIs
Client APIs
Other APIs
🌟 Ai Focus Custom APIs
List all portals in an account
Get details of portals in an Account
curl --request GET \
--url https://app.chatwoot.com/api/v1/accounts/{account_id}/portals \
--header 'api_access_token: <api-key>'{
"payload": [
{
"id": 4,
"color": "#1F93FF",
"custom_domain": "chatwoot.help",
"header_text": "Handbook",
"homepage_link": "https://www.chatwoot.com",
"name": "Handbook",
"page_title": "Handbook",
"slug": "handbook",
"archived": false,
"account_id": 1,
"config": {
"allowed_locales": [
{
"code": "en",
"articles_count": 32,
"categories_count": 9
}
]
},
"inbox": {
"id": 37,
"avatar_url": "https://example.com/avatar.png",
"channel_id": 1,
"name": "Chatwoot",
"channel_type": "Channel::WebWidget",
"greeting_enabled": true,
"widget_color": "#1F93FF",
"website_url": "chatwoot.com"
},
"logo": {
"id": 19399916,
"portal_id": 4,
"file_type": "image/png",
"account_id": 1,
"file_url": "https://example.com/logo.png",
"blob_id": 21239614,
"filename": "square.png"
},
"meta": {
"all_articles_count": 0,
"categories_count": 9,
"default_locale": "en"
}
}
]
}Authorizations
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
The numeric ID of the account
Response
Success
Show child attributes
Show child attributes
The ID of the portal
Whether the portal is archived
The color code for the portal
Configuration settings for the portal
Show child attributes
Show child attributes
Custom domain for the portal
The header text for the portal
Homepage link for the portal
Name of the portal
URL slug for the portal
Page title for the portal
ID of the account the portal belongs to
Show child attributes
Show child attributes
ID of the inbox
The name of the inbox
Website URL
The type of the inbox
The avatar image of the inbox
Widget Color used for customization of the widget
Website Token
The flag which shows whether Auto Assignment is enabled or not
Script used to load the website widget
Welcome title to be displayed on the widget
Welcome tagline to be displayed on the widget
The flag which shows whether greeting is enabled
A greeting message when the user starts the conversation
ID of the channel this inbox belongs to
The flag which shows whether working hours feature is enabled
The flag to enable collecting email from contacts
The flag to enable CSAT survey
Configuration settings for auto assignment
Message to show when agents are out of office
Configuration for working hours of the inbox
Show child attributes
Show child attributes
Day of the week (0-6, where 0 is Sunday)
Whether the inbox is closed for the entire day
Hour when inbox opens (0-23)
Minutes of the hour when inbox opens (0-59)
Hour when inbox closes (0-23)
Minutes of the hour when inbox closes (0-59)
Whether the inbox is open for the entire day
Timezone configuration for the inbox
Webhook URL for callbacks
Whether to allow messages after a conversation is resolved
Whether to lock a contact to a single conversation
Type of sender name to display (e.g., friendly)
Business name associated with the inbox
Whether HMAC verification is mandatory
Selected feature flags for the inbox
Expected reply time
Messaging service SID for SMS providers
Phone number associated with the inbox
Medium of communication (e.g., sms, email)
Provider of the channel
Show child attributes
Show child attributes
ID of the logo file
ID of the portal this logo belongs to
MIME type of the file
ID of the account
URL to access the logo file
ID of the blob
Name of the file
Show child attributes
Show child attributes
Total number of articles
Number of archived articles
Number of published articles
Number of draft articles
Number of categories
Default locale for the portal
curl --request GET \
--url https://app.chatwoot.com/api/v1/accounts/{account_id}/portals \
--header 'api_access_token: <api-key>'{
"payload": [
{
"id": 4,
"color": "#1F93FF",
"custom_domain": "chatwoot.help",
"header_text": "Handbook",
"homepage_link": "https://www.chatwoot.com",
"name": "Handbook",
"page_title": "Handbook",
"slug": "handbook",
"archived": false,
"account_id": 1,
"config": {
"allowed_locales": [
{
"code": "en",
"articles_count": 32,
"categories_count": 9
}
]
},
"inbox": {
"id": 37,
"avatar_url": "https://example.com/avatar.png",
"channel_id": 1,
"name": "Chatwoot",
"channel_type": "Channel::WebWidget",
"greeting_enabled": true,
"widget_color": "#1F93FF",
"website_url": "chatwoot.com"
},
"logo": {
"id": 19399916,
"portal_id": 4,
"file_type": "image/png",
"account_id": 1,
"file_url": "https://example.com/logo.png",
"blob_id": 21239614,
"filename": "square.png"
},
"meta": {
"all_articles_count": 0,
"categories_count": 9,
"default_locale": "en"
}
}
]
}