get
https://production-api.shoutaboutus.com/api/v1/qr-codes/template/list
Get a paginated list of QR code templates scoped to the authenticated user's company, with filtering (store, type, date range), full-text search, and sorting. Each row is decorated with a total_scans count.
Auth: Account — authentication; templates are hard-scoped to the auth user's own company (no partner-tree walk). The optional store_id filter must also sit inside your own account tree, so it must resolve into the auth company's hierarchy.
Rate limit: No rate limit.
Request
- Query:
store_id(integer, optional) — must be an existing location and belong to the auth company (an ownership check). - Query:
template_type(string, optional) — one ofstandard,hangtag,custom. - Query:
start_date(stringY-m-d, optional) — the earliestcreated_atto include; swapped withend_datewhen the two are reversed. - Query:
end_date(stringY-m-d, optional) — the latestcreated_atto include. - Query:
search_field(string, optional) — one ofname,description,template_type,created_at,updated_at,store_name,storeId,total_scans. - Query:
search_value(string, optional) — LIKE value; fortotal_scanssupports exact5, range5-10, gte5+, lte5-. Rejects angle brackets (NameNoAngleBrackets). - Query:
search(string, optional, max 255) — fallbacknameLIKE search, used only whensearch_field/search_valueabsent. - Query:
sort_field(string, optional) — same allowed list assearch_field(plusid). - Query:
sort_by(string, optional) —asc/ASC/desc/DESC; defaults toDESC. Default sort when you omit it iscreated_at DESC. - Query:
per_page(integer, optional, 10–100, default 15; values below 10 are raised to 10).
Response — { data. } envelope wrapping a paginator (the paginator itself is the value of data).
current_page(integer)data(array) — template rows, each selectingid,name,description,template_type,store_id,created_at,updated_at, plus includedstore(id,name,storeId) and an injectedtotal_scans(integer, non-deleted scan count).per_page(integer)total(integer)last_page,from,to,links, etc. (standard paginator fields)
Errors: 422 on validation failure.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
