Returns a paginated list of stores accessible to the authenticated user, each row joined out to full location, account, and geographic detail (city, then state, then country) plus the active store_plan with its plan features, and a generated connect_page_url. Backs getUserStoreWithLocation.
Auth: Both (Partner or Account user) — authentication, role-agnostic store/ group. Default scope is (the caller's own accessible stores). When you supply company_id it scopes for that company, and when you supply store_id it narrows to that one store. Both company_id and store_id must sit inside your own account tree, so a partner can reach any store under its tree while an account user is confined to its own account's stores.
Rate limit: No rate limit.
Request
- Query:
page(integer, optional) — pagination page. - Body:
| Field | Type | Required | Notes |
|---|---|---|---|
| sort_field | string | optional | one of store_name, address, zip, city_name, state_code, company_phone, country_name, state_name, storeid, account_name (default store_name) |
| sort_by | string | optional | asc / ASC / desc / DESC (default ASC) |
| search_field | string | optional | same column set as sort_field |
| search_value | string | optional | term; validated by NameNoAngleBrackets |
| active_plan | int (0|1) | optional | 1 = only stores with an active plan |
| company_id | int | optional | must exist (bundle_id 1/2/3, not deleted) + an ownership check |
| store_id | int | optional | must exist:store + an ownership check |
| limit | int | optional | page size (default 10) |
Response — { data. } envelope; data is the raw paginator (current_page, data[], per_page, total, page urls, links).
data.data[].id(integer) — store id.data.data[].account_name(string) — parent account name.data.data[].store_name,store_full_name,storeid,client_location_id(string) — store identity.data.data[].address,address1,address2,zip(string|null) — location address.data.data[].country_id/_name/_code,state_id/_name/_code,city_id/_name— geo joins.data.data[].company_phone(string|null).data.data[].brand_company_id(integer) — parent account company id.data.data[].connect_page_url(string) — generated connect-review-sites URL.data.data[].active_store_plan(object|null) —{ id, store_id, plan_id, status, plan_start, plan_end, cancel_subscription_at, plan: { id, plan_name, features: [{ id, plan_id, feature_name, options }] } }.
Errors: 422 on validation failure.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||