Skip to main content
GET
List QR Codes

Query Parameters

Usage Notes (query params)

  • ordering example: ?ordering=-dynamic_url_object__visit_count returns most-scanned QR codes first.
  • Date filters accept YYYY-MM-DD (server timezone aware). To filter by exact datetime, use server-side date range with created_from/created_till.
  • The qrid parameter accepts a single QR ID or multiple QR IDs as a comma-separated string (e.g., qrid=Q349...,Qf94...). Note: Use comma-separated values in a single parameter, not repeated query parameters. For example, use ?qrid=Q1,Q2,Q3 instead of ?qrid=Q1&qrid=Q2&qrid=Q3.
  • For scan_type=between, supply both scan_count1 and scan_count2 (e.g., scan_count1=10&scan_count2=100).
  • When filtering by tags, category, or qrid, URL-encode commas (or use repeated parameters depending on your client).

Examples

Get All QR Codes

Pagination

Sorting

Date Filtering

Category and Type Filtering

QR ID Filtering

Tag Filtering

User Filtering

Scan Count Filtering

Complex Filtering

Response Example

Performance & Pagination Best Practices

  • Use sensible page sizes on the client (server defaults to a safe page size). For large exports, use dedicated export endpoints if available.
  • Cache category metadata (it changes rarely) instead of refetching per-QR item.
  • Use server-side sorting (ordering) for accurate, paginated results rather than fetching all pages and sorting client-side.
  • Avoid deep paging with very large offsets; prefer cursor-based or export flows for millions of records.
  • Rate-limit handling: implement retries with exponential backoff for 429 Too Many Requests.

UI/UX Tips for Rendering

  • Show thumbnail if available; fall back to generated QR preview using qr_url.
  • Respect is_active and is_visible flags when listing to end users.
  • Use dynamic_url_object.visit_count and qr_type_display for quick insights.
  • For lists with many columns, provide column toggles — hide expensive fields (full info JSON) by default.

Authorizations

Authorization
string
header
required

API key authentication. Enter your API key directly in the Authorization header.

Query Parameters

page
integer

Page number to retrieve

Required range: x >= 1
ordering
enum<string>

Sort order. Use '-' prefix for descending order

Available options:
created,
-created,
name,
-name,
category__name,
-category__name,
dynamic_url_object__visit_count,
-dynamic_url_object__visit_count
created_from
string<date>

Filter QR codes created from this date (YYYY-MM-DD)

created_till
string<date>

Filter QR codes created till this date (YYYY-MM-DD)

qrid
string

Filter by specific QR code ID(s). Must be a comma-separated list of QR IDs. Example: Q349...,Qf94...

tags
string

Filter by tags (comma-separated, URL encoded)

category
string

Filter by category slugs (comma-separated, URL encoded)

type
enum<string>

Filter by QR code type

Available options:
st,
dy
status
enum<string>

Filter by QR code status

Available options:
active,
inactive
users
string

Filter by user IDs (comma-separated, URL encoded)

scan_type
enum<string>

Filter by scan count comparison type

Available options:
less_than,
between,
greater_than,
equal_to
scan_count1
integer

Primary scan count value (required with scan_type)

Required range: x >= 0
scan_count2
integer

Secondary scan count value (required for 'between' scan_type)

Required range: x >= 0

Search value

search_fields
enum<string>

Fields to search in (comma-separated)

Available options:
qrid,
dynamic_url_object__url_hash,
name

Response

List of QR codes

count
integer

Total number of QR codes

Example:

185

next
integer

Page number for next page (null if no more pages)

Example:

2

previous
integer

Page number for previous page (null if first page)

Example:

null

results
object[]