QRLinkify URL Shortener API for Developers

Introduction

The QRLinkify URL shortener API lets you do everything the dashboard does, from your own application. Create a short link when a user publishes a post. Generate a QR code when an order ships. Pull click and scan analytics into your internal reporting. The API is REST over HTTPS and returns JSON, so it fits any stack that can make an HTTP request.

Base URL

https://api.qrlinkify.com/api/v1

Versioning

The current API version is v1. Breaking changes will be released under a new version path. The v1 path remains stable.

Request format

All POST and PATCH requests must include Content-Type: application/json and a JSON body. GET and DELETE requests do not require a body.

Authentication

Authentication uses a bearer token. Generate an API key from your API Keys dashboard and send it in the Authorization header on every request. Keys are scoped to a workspace, so a key only touches that workspace links, QR codes, and domains. Treat a key like a password, keep it server-side, and rotate it if it is exposed.

Header format

Authorization: Bearer YOUR_API_KEY

Example request

curl https://api.qrlinkify.com/api/v1/links \
  -H "Authorization: Bearer YOUR_API_KEY"

Links API

Create, retrieve, update, and delete short links in your workspace.

Create a short link

Shorten a URL and optionally set a title, UTM parameters, expiry, or password.

curl -X POST https://api.qrlinkify.com/api/v1/links \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "original_url": "https://example.com/long-page",
    "title": "My Landing Page",
    "utm_source": "newsletter"
  }'

Request body fields

List links

Returns a paginated list of links in your workspace.

curl "https://api.qrlinkify.com/api/v1/links?page=1&limit=20" \
  -H "Authorization: Bearer YOUR_API_KEY"

QR Codes API

Generate and manage QR codes linked to your short links.

Generate a QR code

curl -X POST https://api.qrlinkify.com/api/v1/qr \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "link_id": "LINK_ID",
    "name": "Product QR",
    "fg_color": "#1a1a1a",
    "bg_color": "#ffffff",
    "dot_style": "dots"
  }'

Style options

Analytics API

Retrieve click statistics for any link in your workspace. Data is available for the past 30 days on Free, 6 months on Pro, and 12 months on Business.

Link analytics

Pass a period query parameter: 7d, 30d, or 90d.

curl "https://api.qrlinkify.com/api/v1/analytics/links/LINK_ID?period=30d" \
  -H "Authorization: Bearer YOUR_API_KEY"

Webhooks & SDKs

Webhooks let your application react to events without polling. Subscribe to events such as a link being clicked or a QR code being scanned, and QRLinkify sends a signed JSON payload to your endpoint. That is how you trigger downstream actions, like updating a record the moment a campaign link is used.

Official SDKs wrap the REST API so you write less boilerplate. Where an SDK is not available for your language, the API is plain REST and works with any standard HTTP client.

Rate Limits

Rate limits are generous and sized for production traffic. They are applied per API key on a rolling one-hour window. When you exceed the limit, the API returns a 429 Too Many Requests response, and you can retry after the reset. Bulk jobs are better handled through the bulk link endpoints than by hammering the single-link endpoint.

Rate limit headers are included in every response:

Error Codes

All error responses follow a consistent format with an HTTP status code and a JSON body:

{
  "message": "A human-readable description of the error",
  "statusCode": 400
}

FAQ