Account-user location list (GET dropdown)

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) 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. } envelope.

  • status (string) — success.
  • 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.

Errors: 422 on validation failure.

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

Switches to a filtered name lookup; the All row is omitted while searching.

integer

Page size for the filtered lookup; 10–50 (values below 10 are raised to 10).

Response

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