Get account details

Get the details of the current account

GET /api/v1/accounts/{id}

Try it

Get account details

cURL

curl --request GET \
  --url https://app.chatwoot.com/api/v1/accounts/{id} \
  --header 'api_access_token: <api-key>'

200

{
  "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

200

application/json

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

Show child attributes

settings. auto_resolve_after · number

Auto resolve conversations after specified minutes

settings. auto_resolve_message · string

Message to send when auto resolving

settings. auto_resolve_ignore_waiting · boolean

Whether to ignore waiting conversations for auto resolve

custom_attributes · object

Custom attributes of the account

Show child attributes

custom_attributes. plan_name · string

Subscription plan name

custom_attributes. subscribed_quantity · number

Subscribed quantity

custom_attributes. subscription_status · string

Subscription status

custom_attributes. subscription_ends_on · string<date>

Subscription end date

custom_attributes. industry · string

Industry type

custom_attributes. company_size · string

Company size

custom_attributes. timezone · string

Account timezone

custom_attributes. logo · string

Account logo URL

custom_attributes. onboarding_step · string

Current onboarding step

custom_attributes. marked_for_deletion_at · string<date-time>

When account was marked for deletion

custom_attributes. marked_for_deletion_reason · string

Reason for account deletion

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)