List QR codes

get

https://production-api.shoutaboutus.com/api/v1/qr-codes

Get an account's QR codes with scan counts, to manage codes or pick one to print. Returns one entry per code, newest first unless you sort, 15 to a page by default.

Prerequisites: a bearer token for the account.

Authentication: Account token. Lists only the codes of the account of the user behind the token; a Partner token gets an empty list. store_id must be inside your own account tree; otherwise 422.

Rate limit: none.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

store_id

integer

Defaults to 3007

Only this location's codes. Must be inside your account tree.

destination_type

string

enum

Defaults to landing_page

Only codes with this destination: landing_page, review_site or custom_url.

Allowed:

exclude_destination_type

string

enum

Defaults to custom_url

Leave out codes with this destination.

Allowed:

start_date

string

Defaults to 2026-09-01

Only codes created on or after this day (YYYY-MM-DD). Swapped with end_date when the two are reversed.

end_date

string

Defaults to 2026-09-30

Only codes created on or before this day (YYYY-MM-DD).

search_field

string

enum

Defaults to name

The field to search with search_value: name, destination_type, landing_page_id, review_site_id, destination_url, created_at, updated_at, last_scanned_at, store_name, storeId, total_scans.

search_value

string

Defaults to Lobby

What to search for in search_field, up to 255 characters (matches part of the value). For total_scans: 5 (exactly), 5-10 (range), 5+ (at least) or 5- (at most).

string

Defaults to Lobby

Search the code's name, up to 255 characters. Used only when search_field and search_value aren't sent.

sort_field

string

enum

Defaults to created_at

The field to sort by: id or any search_field value. Defaults to created_at.

sort_by

string

enum

Defaults to desc

Sort direction: asc or desc. Defaults to desc.

Allowed:

per_page

integer

Defaults to 15

Codes per page, 10 to 100 (below 10 is raised to 10; above 100 returns 422). Defaults to 15.

page

integer

Defaults to 1

Page number. Defaults to 1.

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 QR codes, or an empty page.

401The token is missing, expired or invalid.

422store_id is outside your tree, a filter or sort value is invalid, or per_page is above 100.

500Unexpected server error.