List widgets

Returns a paginated list of widgets scoped to a single store (store_id) or an account company and its child companies (company_id), joined to widget type, store, and company-account names, with optional search/sort.

Auth: Both — authentication in the role-agnostic account/* group (route name api.brand.widget.list); no HiPages gate. Target must sit inside your own account tree, keyed on store_id/company_id, which walks the auth user's company hierarchy. When store_id is absent, the controller resolves company_id: an account-bundle company (bundle_id = ACCOUNT) lists its own widgets, otherwise it lists widgets of all child companies (childids). A partner reaches a wider tree than an account user, but the param shape is identical.

Rate limit: No rate limit.

Request

  • Body:
FieldTypeRequiredNotes
store_idintegerrequired_without company_idMust Must be an existing location and belong to the auth company hierarchy.
company_idintegerrequired_without store_idMust Must be an existing account and belong to the auth company hierarchy.
limitintegeroptional10–100 (values below 10 are raised to 10); default 10 (per-page size).
pageintegeroptionalmin 1.
sort_fieldstringoptionalOne of widget_title,created_at,updated_at,store_name,unique_id,widget_type,account_name.
sort_bystringoptionalOne of asc,ASC,desc,DESC; default DESC.
search_fieldstringoptionalSame enum as sort_field. store_name=all filters widgets with NULL store_id.
search_valuestringoptionalLike-matched (or date-matched for created_at/updated_at).

Response — raw paginator; data is the array of widget rows.

  • current_page (integer)
  • data[].id (integer)
  • data[].store_id (integer, nullable)
  • data[].unique_id (string) — hashid widget code
  • data[].created_at (datetime)
  • data[].widget_title (string, nullable)
  • data[].widget_type (string) — the widget type's name
  • data[].widget_type_id (integer) — the widget type's id
  • data[].account_name (string, nullable) — the account's name
  • data[].store_name (string, nullable) — store name, suffixed with the client location id when one is set (else the storeid)
  • per_page / total / last_page / links etc. (standard paginator meta)
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
integer
integer
string
string
string
string
Responses

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