Skip to main content
GET
Get a portal details

Authorizations

Authorization
string
header
required

Authenticate with Authorization: Bearer <token> using a user API token from Profile Settings. Available in Chatwoot v4.19.0 and later.

Path Parameters

account_id
integer
required

The numeric ID of the account

id
string
required

The slug identifier of the portal

Response

Success

id
integer

The ID of the portal

archived
boolean

Whether the portal is archived

color
string

The color code for the portal

config
object

Configuration settings for the portal

custom_domain
string

Custom domain for the portal

header_text
string

The header text for the portal

Homepage link for the portal

name
string

Name of the portal

slug
string

URL slug for the portal

page_title
string

Page title for the portal

account_id
integer

ID of the account the portal belongs to

inbox
object
meta
object