List review widgets

post

https://production-api.shoutaboutus.com/api/v1/account/widget/list

Get the account's review widgets with their embed codes. Use this to manage widgets or copy an embed code. Send a store_id (one location) or a company_id (an account, or a partner for all its accounts); if you send both, store_id is used. Returns one page of widgets; the response isn't wrapped in data.

Prerequisites: a bearer token, and a location id (store_id) or an account id (company_id).

Authentication: Partner or Account token. store_id or company_id must be inside your own account tree (a Partner token reaches anything under the partner, an Account token only its own); otherwise 422.

Rate limit: none.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

store_id

integer

Defaults to 3007

A location. Lists that location's widgets. Must exist and be inside your account tree. Required when company_id isn't sent.

company_id

integer

Defaults to 5994

An account (its widgets) or a partner (the widgets of all its accounts). Must exist and be inside your account tree. Required when store_id isn't sent.

limit

integer

Defaults to 10

Widgets per page, 10–100 (values below 10 are raised to 10; above 100 returns 422). Default 10.

page

integer

Defaults to 1

Page number, from 1. Default 1.

sort_field

string

enum

Defaults to created_at

Field to sort by. Without it, no sort order is applied.

Allowed:

sort_by

string

enum

Defaults to DESC

Sort direction when sort_field is sent. Default DESC.

Allowed:

search_field

string

enum

Defaults to widget_title

Field to search, used with search_value. Same values as sort_field.

Allowed:

search_value

string

Defaults to Feed

Text to search for (partial match). For created_at / updated_at, a date. With search_field store_name, all lists widgets with no location.

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A page of widgets, or an empty page when there are none.

401The token is missing, expired or invalid.

422Neither store_id nor company_id was sent, an id doesn't exist or is outside your tree, a sort or search value isn't allowed, or limit is above 100.

500Unexpected server error.