Get one account

Overview

Get the full details of a single account: business info, owner, plan, and settings.

Use this when you need everything about one business, for example to pre-fill an edit form before Edit an account.

You'll need the account's id, or your own client_account_id for it.

Returns the account, its owner and its plan id.

Prerequisites

A Partner or Account token. See Authentication.
The account's id (brandId), e.g. from List your accounts, or your client_account_id.

Base URL

Environment	URL
Production	`https://production-api.shoutaboutus.com`
Development	`https://development-api.shoutaboutus.com`

Endpoint

GET /api/v1/partner/account/{brandId}

Authentication

Partner or Account token

An Account token reaches only its own account.
The account must be inside your account tree. An id that doesn't exist, was deleted, isn't an account, or is outside your tree returns 404.
An account that belongs to another partner returns 403.
When you send client_account_id, it's looked up among your own accounts only, and it takes the place of the path id.

Rate limit

This endpoint has no rate limit.

Request parameters

Parameter	In	Type	Required	Description
`brandId`	path	integer	Yes	The account's id.
`client_account_id`	query	string	No	Your own id for the account. When sent, it's used instead of `brandId`; `404` if none of your accounts has it.

Request body

None.

Request payload

None.

Response body

The payload is inside data.

Field	Type	Description
`account`	object	The account.
`account.id`	integer	The account's id.
`account.name`	string	The account's name.
`account.company_id`	integer	The id of the partner (or sub-partner) the account sits under.
`account.site_url`	string or null	Site URL. Usually `null`; the account's website is in `website`.
`account.address`	string	Street address.
`account.city_id`	integer	The city's id.
`account.zip`	string	Postal code.
`account.company_phone`	string or null	The business phone.
`account.billing_id`	string or null	Your billing reference.
`account.client_account_id`	string or null	Your own id for the account.
`account.phone`	string or null	The owner's phone as given when the account was created.
`account.bundle_id`	integer	Always `3` (an account).
`account.website`	string or null	The business website.
`account.companyindustry_id`	integer or null	The industry's id.
`account.created_at`	string	When the account was created.
`account.company_option`	object or null	The account's settings.
`account.company_option.id`	integer	The settings record's id.
`account.company_option.company_id`	integer	The account's id.
`account.company_option.who_will_pay`	string	Who pays for the account, e.g. `partner`.
`account.company_option.enable_generic_alert`	boolean	Whether generic alerts are on.
`account.company_option.enable_insight_report`	boolean	Whether insight reports are on.
`account.company_option.enable_competitive_analysis`	boolean	Whether competitive reports are on.
`account.city`	object or null	The city, with `id`, `name`, `state_id` and `country_id`.
`account.city.id`	integer	The city's id.
`account.city.name`	string	The city's name.
`account.city.state_id`	integer	The state's id.
`account.city.country_id`	integer	The country's id.
`account.city.state`	object	The state, with `id`, `name`, `country_id` and `code`.
`account.city.state.id`	integer	The state's id.
`account.city.state.name`	string	The state's name.
`account.city.state.country_id`	integer	The country's id.
`account.city.state.code`	string	The state's code, e.g. `NSW`.
`account.city.state.country`	object	The country, with `id`, `name` and `code`.
`account.city.state.country.id`	integer	The country's id.
`account.city.state.country.name`	string	The country's name.
`account.city.state.country.code`	string	The country's code, e.g. `AU`.
`account.companyindustry`	object or null	The account's industry: `id` and `name`.
`account.companyindustry.id`	integer	The industry's id.
`account.companyindustry.name`	string	The industry's name.
`account.inherited_industry`	object or null	Your partner's industry (`id` and `name`), used as the default when the account has none. `null` when your partner has no industry.
`owner`	object or null	The account's owner, or `null` when it has none.
`owner.first_name`	string or null	The owner's first name.
`owner.last_name`	string or null	The owner's last name.
`owner.email`	string	The owner's email.
`owner.phone`	string or null	The owner's phone.
`plan_id`	integer or null	The id of the account's plan, or `null` when it has none.

Response payload

{
  "data": {
    "account": {
      "id": 5994,
      "name": "Acme Coffee",
      "company_id": 2,
      "site_url": null,
      "address": "1 George St",
      "city_id": 3243,
      "zip": "2000",
      "company_phone": null,
      "billing_id": null,
      "client_account_id": "docs-test-acct-001",
      "phone": null,
      "bundle_id": 3,
      "website": "https://www.shoutaboutus.com",
      "companyindustry_id": 37,
      "created_at": "2026-09-23T10:43:43.000000Z",
      "company_option": {
        "id": 5963,
        "company_id": 5994,
        "who_will_pay": "partner",
        "enable_generic_alert": false,
        "enable_insight_report": false,
        "enable_competitive_analysis": false
      },
      "city": {
        "id": 3243,
        "name": "Sydney",
        "state_id": 3909,
        "country_id": 14,
        "state": {
          "id": 3909,
          "name": "New South Wales",
          "country_id": 14,
          "code": "NSW",
          "country": {
            "id": 14,
            "name": "Australia",
            "code": "AU"
          }
        }
      },
      "companyindustry": {
        "id": 37,
        "name": "Business Services"
      },
      "inherited_industry": null
    },
    "owner": {
      "first_name": "Jane",
      "last_name": "Smith",
      "email": "[email protected]",
      "phone": null
    },
    "plan_id": 36
  }
}

Examples

Success payload

See Response payload.

Error payload

403 Another partner's account

{
  "message": "Forbidden",
  "status": "error",
  "errors": "You do not have access to this account."
}

404 Account not found

{
  "message": "Not Found",
  "status": "error",
  "errors": "Account not found."
}

Status	Meaning
`200`	The account.
`401`	The token is missing, expired or invalid.
`403`	The account belongs to another partner.
`404`	`Account not found.`: the id is unknown, deleted, not an account, or outside your account tree, or no account of yours has the `client_account_id`.
`500`	Unexpected server error.

Example request

curl --request GET \
  --url "https://production-api.shoutaboutus.com/api/v1/partner/account/5994" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json'