Skip to main content
apiBase URL:https://v1.freeqr.io/api

FreeQR Developer
API Reference

Create QR codes, build landing pages, manage projects, and track everything. All through a simple REST API.

Get API Keyarrow_forwardRead the Docsmenu_book

Get started in minutes

Three steps to your first QR code. No SDK required, just HTTP.

01
key

Get your API key

Sign up and generate a Bearer token from your dashboard. All requests are authenticated via the Authorization header.

Authentication guidearrow_forward
02
terminal

Make your first request

Create a project, then generate a QR code. All endpoints use JSON and return consistent response shapes.

Quick startarrow_forward
03
rocket_launch

Build and ship

Use pages, templates, and components to build landing experiences. Manage everything programmatically.

API resourcesarrow_forward

One request to create a QR code

Send a POST request with your API key and a JSON body. The response includes the QR code data, download URL, and tracking metadata.

check_circle

JSON in, JSON out

Consistent application/json for all endpoints

check_circle

Standard HTTP status codes

200, 201, 204 for success. 400, 401, 403, 404, 422, 500 for errors.

check_circle

Pagination built in

page and limit on every list endpoint

curl -X POST https://v1.freeqr.io/api/projects \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "name": "New Project"
  }'

API Resources

Full CRUD operations on every resource. Manage your entire QR code ecosystem programmatically.

folder_open

Projects

arrow_outward

Create and manage projects. Attach users, organize QR codes and pages.

GETPOSTPATCHDELETE
web

Pages

arrow_outward

Build landing pages with components. Public access and password protection.

GETPOSTPATCHDELETE
qr_code_2

QR Codes

arrow_outward

Generate dynamic QR codes within projects. Full CRUD operations.

GETPOSTPATCHDELETE
widgets

Components

arrow_outward

Page building blocks. Create, update, delete, and bulk manage components.

GETPOSTPATCHDELETE
palette

Templates

arrow_outward

Design templates and versioning for consistent page styling.

GETPOST
upload_file

Files

arrow_outward

Upload, download, and manage media files for your projects.

GETPOSTDELETE
dns

Domains

arrow_outward

List available platform domains for your QR code destinations.

GET
dynamic_form

Form Submissions

arrow_outward

Collect and manage form submissions from your landing pages.

GETPOST

Utilities

Public endpoints that don't require authentication. Generate and scan QR codes instantly.

qr_code
Public

QR Code Generatorarrow_outward

Generate QR code images on the fly. Supports GET and POST with full customization: colors, logos, shapes, and formats.

document_scanner
Public

Scannerarrow_outward

Decode QR codes from an image URL or uploaded file. Extract embedded data instantly.

Built for developers

Consistent conventions across every endpoint. Predictable, well-documented, easy to integrate.

lock

Bearer Auth

Token-based authentication over HTTPS

data_object

JSON API

application/json requests and responses

view_list

Pagination

page & limit params, max 10,000 offset

filter_alt

Filtering

filters[field] query parameters

sort

Sorting

sort param with - prefix for descending

speed

Rate Limiting

X-RateLimit headers on every response

Ready to build?

Get your API key and start creating QR codes in minutes. Full documentation, public utilities, no credit card required.

Get Started Freearrow_forwardExplore the docsarrow_outward