List 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 of landing_page, review_site, custom_url.
  • Query: exclude_destination_type (string, optional) — one of landing_page, review_site, custom_url.
  • Query: start_date (string Y-m-d, optional) — filters created_at from this day.
  • Query: end_date (string Y-m-d, optional) — filters created_at to this day.
  • Query: search_field (string, optional) — one of name, 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 with search_field. For total_scans accepts exact 5, range 5-10, gte 5+, or lte 5-.
  • Query: search (string, optional, max 255) — fallback name like search (used only when search_field/search_value absent).
  • Query: sort_field (string, optional) — same enum as search_field.
  • Query: sort_by (string, optional) — asc/ASC/desc/DESC (defaults DESC).
  • 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 computed total_scans (int) and the QrCode's appended qr_code_image_url. Also returns store: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
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Response

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