Get account details

Get a single account with everything the account-edit form needs: account row + company_options + city/state/country, the owner (name/email/phone), and the account's current plan_id. Returns 404 if the target is missing or not an account (bundle_id != 3).

Auth: Partner — authentication under partner/account. The endpoint validates the path id with Must be an existing account inside your own account tree. A partner-supplied client_account_id query param (if present) takes precedence and resolves to the account within the caller's partner only. After load, controller walks getParentCompany(brand,'partner') and enforces canManageBrand (super-admin or matching partner) else 403.

Rate limit: No rate limit.

Request

  • Query: client_account_id (string, optional) — partner-supplied external id; overrides the path id (404 if it resolves to none within the partner).

Response{ data. } envelope wrapping an inner data object.

  • data.account (object) — selected account fields: id, name, company_id, site_url, address, city_id, zip, company_phone, billing_id, client_account_id, phone, bundle_id, website, created_at. Plus company_option (id, company_id, who_will_pay, enable_generic_alert, enable_insight_report, enable_competitive_analysis) and a nested city.state.country.
  • data.owner (object|null) — first_name, last_name (from person), email, phone (from user); null if no owner.
  • data.plan_id (integer|null) — latest company_plans.plan_id for the account.

Path params

ParameterTypeRequiredNotes
brandIdintegerRequiredDigits only.

Errors: 422 on validation failure.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json