Account-user location list (GET dropdown)

Overview

Get a flat label/value list of the stores the authenticated user can access, for dropdowns. An All option is prepended when there are 2+ stores, or whenever appendAll is truthy. Backs getUserStoreList.

Prerequisites

• A bearer token. Callable with Partner and Account tokens.

Base URL

Endpoint

GET /api/v1/store/list

Authentication

• Requires a bearer token in the Authorization: Bearer <bearer-token> header.

• Who can call it: Partner and Account tokens.

• (Partner or Account user) — authentication, role-agnostic store/ group.

• Scope is keyed off the caller's. A partner sees every store under its tree. An account user sees only its own account's stores.

• No per-row ownership params on this route.

Rate limit

• No rate limit.

Query parameters

• Query: active_plan (integer, optional) — 0 (default, all) or 1 (only stores with an active plan).
• Query: appendAll (integer/any, optional) — when truthy, forces the All option even with a single store.
• Query: search (string, optional, max 255) — switches to a filtered name lookup; the All row is omitted while searching.
• Query: limit (integer, optional) — page size for the filtered lookup; 10–50 (values below 10 are raised to 10).

Response

• data.status (string) — success.
• data.response (array) — list of { label, value }; label is name or name - storeid, STATE and value is the store id. All row (value: "") prepended per the count/appendAll rule. Empty array when the user has no stores.

200 OK · 200

{
  "data": {
    "status": "success",
    "response": [
      {
        "label": "All",
        "value": ""
      },
      {
        "label": "Demo Brew - Alameda County, CA",
        "value": 2
      },
      {
        "label": "GSLoc - SID123",
        "value": 14
      }
    ]
  }
}

Errors

Example request

curl --request GET \
  --url "https://production-api.shoutaboutus.com/api/v1/store/list?active_plan=1&appendAll=1" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json'