get
https://production-api.shoutaboutus.com/api/v1/store/list
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.
Auth: Both (Partner or Account user) — authentication, role-agnostic store/ group. Scope is keyed off the caller's, so a partner sees every store under its tree and an account user only its own account's stores. No per-row ownership params on this route.
Rate limit: No rate limit.
Request
- Query:
active_plan(integer, optional) —0(default, all) or1(only stores with an active plan). - Query:
appendAll(integer/any, optional) — when truthy, forces theAlloption even with a single store. - Query:
search(string, optional, max 255) — switches to a filtered name lookup; theAllrow 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. } envelope.
status(string) —success.response(array) — list of{ label, value };labelisnameorname - storeid, STATEandvalueis the store id.Allrow (value: "") prepended per the count/appendAll rule. Empty array when the user has no stores.
Errors: 422 on validation failure.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
