get
https://production-api.shoutaboutus.com/api/v1/qr-codes
Get a paginated list of QR codes scoped to the authenticated account-user's company, with each row's total_scans computed from scan history. Supports filtering by store, destination type, date range, free-text/field search, and sorting.
Auth: Account — authentication; rows are hard- (the account company). The optional store_id filter must also sit inside your own account tree.
Rate limit: No rate limit.
Request
- Query:
store_id(integer, optional) — must Must be an existing location and belong to the auth company hierarchy. - Query:
destination_type(string, optional) — one oflanding_page,review_site,custom_url. - Query:
exclude_destination_type(string, optional) — one oflanding_page,review_site,custom_url. - Query:
start_date(stringY-m-d, optional) — filterscreated_atfrom this day. - Query:
end_date(stringY-m-d, optional) — filterscreated_atto this day. - Query:
search_field(string, optional) — one ofname,destination_type,landing_page_id,review_site_id,destination_url,created_at,updated_at,last_scanned_at,store_name,storeId,total_scans. - Query:
search_value(string, optional, max 255) — paired withsearch_field. Fortotal_scansaccepts exact5, range5-10, gte5+, or lte5-. - Query:
search(string, optional, max 255) — fallback namelikesearch (used only whensearch_field/search_valueabsent). - Query:
sort_field(string, optional) — same enum assearch_field. - Query:
sort_by(string, optional) —asc/ASC/desc/DESC(defaultsDESC). - Query:
per_page(integer, optional, 10–100, default 15; values below 10 are raised to 10).
Response — { data. } envelope wrapping a paginator.
data.current_page(int)data.data[](array of QrCode rows) — selected columns:id,name,destination_type,store_id,landing_page_id,review_site_id,destination_url,customization,last_scanned_at,created_at,updated_at,qr_code_image_path, plus computedtotal_scans(int) and the QrCode's appendedqr_code_image_url. Also returnsstore:id,name,storeId,landingPage:id,reviewSite:id.data.per_page(int),data.total(int),data.last_page(int), and the rest of the standard paginator keys.
Errors: 422 on validation failure.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
