Skip to main content
GET
/
api
/
v1
/
accounts
/
{id}
Get account details
curl --request GET \
  --url https://app.chatwoot.com/api/v1/accounts/{id} \
  --header 'api_access_token: <api-key>'
{
  "id": 123,
  "name": "<string>",
  "locale": "<string>",
  "domain": "<string>",
  "support_email": "<string>",
  "status": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "cache_keys": {},
  "features": [
    "<string>"
  ],
  "settings": {
    "auto_resolve_after": 123,
    "auto_resolve_message": "<string>",
    "auto_resolve_ignore_waiting": true
  },
  "custom_attributes": {
    "plan_name": "<string>",
    "subscribed_quantity": 123,
    "subscription_status": "<string>",
    "subscription_ends_on": "2023-12-25",
    "industry": "<string>",
    "company_size": "<string>",
    "timezone": "<string>",
    "logo": "<string>",
    "onboarding_step": "<string>",
    "marked_for_deletion_at": "2023-11-07T05:31:56Z",
    "marked_for_deletion_reason": "<string>"
  },
  "latest_chatwoot_version": "3.0.0",
  "subscribed_features": [
    "<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

Response

Success

​
id
number

Account ID

​
name
string

Name of the account

​
locale
string

The locale of the account

​
domain
string

The domain of the account

​
support_email
string

The support email of the account

​
status
string

The status of the account

​
created_at
string<date-time>

The creation date of the account

​
cache_keys
object

Cache keys for the account

​
features
string[]

Enabled features for the account

​
settings
object

Account settings

​
custom_attributes
object

Custom attributes of the account

​
latest_chatwoot_version
string

Latest version of Chatwoot available

Example:

"3.0.0"

​
subscribed_features
string[]

List of subscribed enterprise features (if enterprise edition is enabled)

⌘I