Get one location

Overview

Get a single location with its account, address, and current plan.

Use this when you need everything about one location.

You'll need the store_id.

Returns the location, with its address and phones under company and its active plan under active_store_plan.

Prerequisites

A Partner or Account token. See Authentication.
The location's id (storeId), e.g. from List an account's locations.

Base URL

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

Endpoint

GET /api/v1/store/{storeId}

Authentication

Partner or Account token

The location must be one the user behind the token can access: a Partner token reaches any location in its tree, an Account token only its own account's locations.
Any other id returns 404.

Rate limit

This endpoint has no rate limit.

Request parameters

Parameter	In	Type	Required	Description
`storeId`	path	integer	Yes	The location's id.

Request body

None.

Request payload

None.

Response body

The payload is inside data.

Field	Type	Description
`status`	string	`success`.
`data`	object	The location.
`data.id`	integer	The location's id (`store_id`).
`data.account_name`	string	The account's name.
`data.store_name`	string	The location's name.
`data.store_full_name`	string	The name, plus `- <client_location_id>` (or `- <storeid>` when it has no `client_location_id`).
`data.storeid`	string	The location's display label.
`data.client_location_id`	string or null	Your own id for the location.
`data.company_id`	integer	The id of the location's company record (the one in `company`).
`data.active_store_plan`	object or null	The location's active plan, or `null` when it has none.
`data.active_store_plan.id`	integer	The subscription's id.
`data.active_store_plan.store_id`	integer	The location's id.
`data.active_store_plan.plan_id`	integer	The plan's id.
`data.active_store_plan.status`	string	The subscription's status, e.g. `active`.
`data.active_store_plan.plan_start`	string	When the subscription started.
`data.active_store_plan.plan_end`	string	When the subscription ends.
`data.active_store_plan.cancel_subscription_at`	string or null	When it was cancelled, or `null`.
`data.active_store_plan.plan`	object	The plan: `id`, `plan_name` and `features`.
`data.active_store_plan.plan.id`	integer	The plan's id.
`data.active_store_plan.plan.plan_name`	string	The plan's name.
`data.active_store_plan.plan.features`	array	The plan's features.
`data.active_store_plan.plan.features[].id`	integer	The feature row's id.
`data.active_store_plan.plan.features[].plan_id`	integer	The plan's id.
`data.active_store_plan.plan.features[].feature_name`	string	The feature, e.g. `ai_response`.
`data.active_store_plan.plan.features[].enabled`	boolean	Whether the feature is on in the plan.
`data.active_store_plan.plan.features[].hard_stop`	boolean	`true`: the feature stops at its limit. `false`: usage over the limit is billed as overage.
`data.active_store_plan.plan.features[].options`	array	The feature's display title, when one is set: each with `id`, `feature_value`, `plan_feature_id` and `feature_key` (`title`). Usually `[]`.
`data.company`	object	The location's address and contact details.
`data.company.id`	integer	The record's id (same as `data.company_id`).
`data.company.address`	string	Street address.
`data.company.address2`	string or null	Second address line.
`data.company.zip`	string	Postal code.
`data.company.city_id`	integer	The city's id.
`data.company.site_url`	string or null	The location's website.
`data.company.company_phone`	string or null	The primary business phone.
`data.company.billing_id`	string or null	The billing reference.
`data.company.phone`	string or null	The secondary phone line.
`data.company.city`	object or null	The city: `id`, `name`, `state_id` and `state`.
`data.company.city.id`	integer	The city's id.
`data.company.city.name`	string	The city's name.
`data.company.city.state_id`	integer	The state's id.
`data.company.city.state`	object	The state: `id`, `name`, `country_id`, `code` and `country`.
`data.company.city.state.id`	integer	The state's id.
`data.company.city.state.name`	string	The state's name.
`data.company.city.state.country_id`	integer	The country's id.
`data.company.city.state.code`	string	The state's code, e.g. `NSW`.
`data.company.city.state.country`	object	The country: `id`, `name` and `code`.
`data.company.city.state.country.id`	integer	The country's id.
`data.company.city.state.country.name`	string	The country's name.
`data.company.city.state.country.code`	string	The country's code, e.g. `AU`.

Response payload

{
  "data": {
    "status": "success",
    "data": {
      "id": 3007,
      "account_name": "Acme Coffee",
      "store_name": "Acme Coffee",
      "store_full_name": "Acme Coffee - docs-test-loc-001",
      "storeid": "Sydney",
      "client_location_id": "docs-test-loc-001",
      "company_id": 5995,
      "active_store_plan": {
        "id": 14935,
        "store_id": 3007,
        "plan_id": 36,
        "status": "active",
        "plan_start": "2026-10-01T01:00:23.000000Z",
        "plan_end": "2026-10-31T23:59:59.000000Z",
        "cancel_subscription_at": null,
        "plan": {
          "id": 36,
          "plan_name": "Growth — Unlimited",
          "features": [
            {
              "id": 1116,
              "plan_id": 36,
              "feature_name": "ai_response",
              "enabled": true,
              "hard_stop": false,
              "options": []
            },
            {
              "id": 1117,
              "plan_id": 36,
              "feature_name": "review_flag",
              "enabled": true,
              "hard_stop": false,
              "options": []
            },
            {
              "id": 1118,
              "plan_id": 36,
              "feature_name": "response_to_past_reviews",
              "enabled": true,
              "hard_stop": false,
              "options": []
            }
          ]
        }
      },
      "company": {
        "id": 5995,
        "address": "1 George St",
        "address2": null,
        "zip": "2000",
        "city_id": 3243,
        "site_url": "https://www.shoutaboutus.com",
        "company_phone": null,
        "billing_id": null,
        "phone": "0291234567",
        "city": {
          "id": 3243,
          "name": "Sydney",
          "state_id": 3909,
          "state": {
            "id": 3909,
            "name": "New South Wales",
            "country_id": 14,
            "code": "NSW",
            "country": {
              "id": 14,
              "name": "Australia",
              "code": "AU"
            }
          }
        }
      }
    }
  }
}

The example shows three of the plan's features.

Examples

Success payload

See Response payload.

Error payload

404 Store not found

The location doesn't exist, or the user behind the token can't access it.

{
  "message": "Store not found",
  "status": "error",
  "errors": []
}

Status	Meaning
`200`	The location.
`401`	The token is missing, expired or invalid.
`404`	The location doesn't exist, or you can't access it.
`500`	Unexpected server error.

Example request

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