Retrieve account information

Retrieve the hosted account and plan information for the account that owns the API key. This is the v3 replacement for the v1 account_view action.

Authenticate with your account's API key in the Api-Token request header. Only users in the Admin group may call this endpoint; requests authenticated as any other user return 403, as do requests with a missing or invalid Api-Token.

❗️

Not the same as /accounts

This endpoint returns information about your ActiveCampaign hosted account (billing plan, contact limits, trial and credit status). It is unrelated to the /accounts endpoints, which manage CRM accounts (the organizations your contacts belong to).

Migrating from v1 account_view

v1 (account_view)v3 (GET /settings/account)Notes
accountaccountUnchanged.
emailemailUnchanged.
fnamefirst_nameRenamed.
lnamelast_nameRenamed.
cnamecnameUnchanged. An empty string when no CNAME is applied.
statusstatusUnchanged.
subscriber_limitsubscriber_limitNow an integer instead of a string.
subscriber_totalNew. The current number of contacts in the account.
trialtrialAlways present in v3 as a boolean. In v1 the key was omitted entirely for non-trial accounts.
creditscreditsAlways present in v3. It is an integer for credit-based plans and null for every other plan. In v1 the key was omitted for non credit-based plans.
brandingNew. A boolean that is true when ActiveCampaign branding links are shown on the account's content.
result_code, result_message, result_outputRemoved. v3 uses HTTP status codes instead of a result envelope.

The v3 response is a flat JSON object without the v1 result envelope, and the response is never cached (Cache-Control: private).

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json