QRTRAC

QRTRAC

API Documentation
Demo

QRTRAC API (2.0.0)

Download OpenAPI specification:Download

QRTRAC Support: support@qrtrac.com

Overview

Welcome to the QRTRAC API — a powerful, enterprise-grade REST API for creating, managing, and tracking QR codes at scale. Built for developers who need reliable, flexible QR code management with advanced features like team collaboration, bulk operations, and comprehensive analytics.

What is QRTRAC?

QRTRAC is a comprehensive platform that enables businesses to generate, manage, and track QR codes programmatically. Whether you're building a marketing campaign, implementing contactless solutions, or managing digital assets, QRTRAC provides the infrastructure and tools you need.

Key Features:

  • Multiple QR Code Types: Short Links, List Of Links, Website URL, Digital Business Card, PDF Document, Multi-Language Redirect, Image Gallery, Social Bio Page, App Download, Restaurant Menu, Coupon Codes, and Location Tracking. See qrtrac.com for more details.
  • Team Collaboration: Multi-user support with role-based access control (Owner, Admin, Editor, Viewer)
  • Custom Short URLs: Create branded, memorable short links for your QR codes
  • Analytics & Tracking: Monitor QR code performance and engagement
  • Enterprise Security: API key-based authentication with team context isolation

API Capabilities

The QRTRAC API is organized into the following functional areas:

QR Code Management

Full CRUD operations for QR codes including creation, updates, deletion, and duplication. Bulk operations for creating up to 25 QR codes per request, duplicating a QR code by quantity, and tagging, deleting, or transferring many QR codes at once. Support for pagination, search, filtering, and sorting.

QR Code Design Templates

Create, duplicate, list, and delete reusable QR code design templates, then apply them when creating QR codes via templateId.

Digital Business Card Templates

Fetch the 50 Digital Business Card designs as ready-to-render HTML, CSS and metadata, so your own app can show a card exactly as it appears when the QR code is scanned.

Analytics & Tracking

Retrieve detailed scan analytics data for individual QR codes or bulk analytics for multiple QR codes within specified time ranges, or every scan across your organization. Track scan events, device information, geographic data, and engagement metrics.

Team & Organization Management

Create and manage teams within your organization, configure domain preferences, and control access with granular permissions.

Team Member Management

Invite, activate, pause, and manage team members with role-based permissions. Support for bulk member operations across multiple teams.

Getting Started

Follow these steps to start using the QRTRAC API:

Step 1: Create an Account and Upgrade to a Paid Plan

Sign up at qrtrac.com/signup and upgrade to a Business Plus plan or higher to get API access. API access is available on paid plans only. Check pricing at qrtrac.com/#pricing.

Step 2: Get Your API Credentials

Navigate to app.qrtrac.com/pages/api to retrieve your Client ID and Client Secret. These credentials are required for all API operations.

Note: You must have an Owner or Admin role and be on a Business Plus plan or higher to access the API. Check pricing at qrtrac.com/#pricing.

Rotating your Client Secret: If your secret is exposed, the organization Owner can generate a new one from the same page. Your Client ID stays the same, so integrations only need the new secret. The old secret stops working within about a minute. A secret can be rotated at most twice in 24 hours.

Step 3: Get Your Team ID

Your Team ID can be obtained from the API page in the application at app.qrtrac.com/pages/api. This team ID is required for most operations.

Step 4: Create Your First QR Code

Use the /qrs-api POST endpoint to create your first QR code. You'll need your team ID, client ID, and client secret. Specify the QR type, redirect URL, and any custom settings.

Step 5: Explore the API

Browse the available endpoints in the sidebar to discover all available operations. Each endpoint includes detailed request/response examples.

Quick Example

Here's a complete example of creating a QR code:

# Get your Client ID and Client Secret from https://app.qrtrac.com/pages/api
# Note: Owner/Admin role and Business Plus plan or higher required
# Then make your API request:

curl -X POST https://api.qrtrac.com/api/qrs-api \
  -H "x-request-team-id: <team_id>" \
  -H "x-request-client-id: <client_id>" \
  -H "x-request-client-secret: <client_secret>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Product Launch Landing Page",
    "qrType": "WEB",
    "displayId": "product-launch-2024",
    "qrRedirectUrl": "https://acmecorp.com/product-launch"
  }'

For more examples in multiple languages (cURL, Python, Node.js, Java, C#), see the Create QR Code and Get QR by ID endpoints.

Model Context Protocol (MCP) & AI Agents

In addition to this REST API, QRTRAC provides an official Model Context Protocol (MCP) server for AI assistants (ChatGPT, Claude, Cursor, and autonomous agent frameworks).

  • Server Endpoint: https://mcp.qrtrac.com/mcp
  • Protocol: Streamable HTTP / Server-Sent Events (SSE) with OAuth 2.1
  • Live Setup Guide: qrtrac.com/mcp/

Digital Business Card (vCard) MCP Tool

AI agents can generate full-featured dynamic Digital Business Card QR codes using the create_vcard_qr_code tool:

{
  "name": "create_vcard_qr_code",
  "arguments": {
    "firstName": "Sarah",
    "lastName": "Connor",
    "company": "Cyberdyne Systems",
    "designation": "Chief Technology Officer",
    "email": "sarah@cyberdyne.com",
    "mobileNumber": "+1-555-0142",
    "website": "https://cyberdyne.com",
    "address": "100 Tech Blvd",
    "city": "San Francisco",
    "state": "CA",
    "country": "USA",
    "summary": "Building resilient, AI-powered systems."
  }
}

Key Capabilities:

  • 1-Tap Contact Saving: Scanning the QR code opens an interactive mobile landing page with an instant Save Contact button that downloads a .vcf file directly into iOS (iPhone Contacts) and Android address books.
  • Dynamic & Repointable: Contact details can be updated anytime using update_vcard_qr_code without reprinting the physical QR code.
  • Custom Branding: Supports profile photos, company logos (via upload_image), and custom domain redirect URLs.

Full MCP Tool Reference

Category Tool Description Inputs
Contact Cards create_vcard_qr_code Generate dynamic Digital Business Card (vCard) with .vcf download firstName, lastName, company, designation, email, mobileNumber, website, etc.
Contact Cards update_vcard_qr_code Update details on an existing digital business card qrId, contact fields
Create & Manage create_qr_code Generate dynamic QR code (Web, PDF, Short Link, Menu, etc.) destinationUrl, name, qrType, folderId
Create & Manage update_qr_code Repoint an existing live code to a new URL qrId, destinationUrl, name
Create & Manage delete_qr_code Permanently delete a QR code qrId
Link-in-Bio create_link_list_qr_code Create a multi-button landing page for social links links, title, profileImageUrl
Link-in-Bio update_link_list_qr_code Update buttons and theme on a link list qrId, links
Media upload_image Upload logo or profile image to team media library sourceUrl or base64 data
Folders list_folders List team folders and sub-folders none
Folders create_folder Create organization folder name, parentId
Analytics get_qr_analytics Lifetime and daily scan volume for codes qrIds, days, startDate, endDate
Analytics get_scan_breakdown Device, OS, browser, and city breakdowns qrId, limit
Analytics get_team_scan_summary Leaderboard of top-performing codes across the team limit
Connection get_connection Active team and account details for current session none

Base URLs

The API is available at the following base URL:

  • Production: https://api.qrtrac.com/api

Response Format

All API responses follow a consistent format:

{
  "success": true,
  "data": { ... }
}

Error responses include a message field:

{
  "success": false,
  "message": "Error description"
}

Rate Limits

API rate limits are applied per team and vary based on your subscription plan. Rate limit information is included in response headers:

  • X-RateLimit-Limit: Maximum number of requests allowed
  • X-RateLimit-Remaining: Number of requests remaining
  • X-RateLimit-Reset: Time when the rate limit resets

Plan-Based Rate Limits

API access is available on the following plans with increasing request limits:

  • Business Plus: 5 requests per second
  • Legendary: 20 requests per second
  • Agency: 50 requests per second
  • Premium: 100 requests per second
  • Enterprise: 200 requests per second (or custom limits based on your needs)

Rate limits are enforced on a per-team basis. If you exceed your plan's rate limit, you'll receive a 429 Too Many Requests response. Contact support@qrtrac.com to upgrade your plan or discuss custom rate limits for Enterprise customers.

Support & Resources

For additional help, questions, or to report issues, please contact our support team.

QR Codes

QR code creation, management, and operations

Create QR Code

Create a new QR code. Requires authentication using client ID and client secret, along with team context.

Required Headers:

  • x-request-team-id: <team_id> - Team ID for the request context
  • x-request-client-id: <client_id> - Client ID from API menu
  • x-request-client-secret: <client_secret> - Client Secret from API menu

Note: Client ID and Client Secret can be obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required. Check pricing at qrtrac.com/#pricing.

Optional Parameters:

  • templateId: Template ID for QR code design. Can be found at app.qrtrac.com/pages/api. If not provided, default template is used.
  • baseUrl: Custom domain base URL for QR codes. Must end with '/'. Prerequisite: Custom domain must be configured in the application. Can be found at app.qrtrac.com/pages/api. Example: If main domain is qrtrac.com and custom domain subdomain qr.qrtrac.com is configured, the baseUrl would be https://qr.qrtrac.com/. If not provided, default domain is used.

Middleware: checkQrLimit, canAddUpdateQr

Supported QR Types

Type Description
WEB Simple URL redirect
PDF PDF document viewer
VCARD Digital business card
MULTI_LOCALE Multi-language URLs
APP_DOWNLOAD App store links
LINK_LIST Multiple links page
SHORT_LINK URL shortener
COUPON_CODE Coupon codes
IMAGE_GALLERY Image gallery
SOCIAL_BIO Social bio page
VIDEO_PREVIEW Video preview
RESTAURANT_MENU Restaurant menu
header Parameters
x-request-team-id
required
string

Team ID for the request context

x-request-client-id
required
string

Client ID obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

x-request-client-secret
required
string

Client Secret obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

Request Body schema: application/json
name
string

QR code name (defaults to "Untitled")

qrType
required
string
Enum: "WEB" "PDF" "VCARD" "MULTI_LOCALE" "APP_DOWNLOAD" "LINK_LIST" "SHORT_LINK" "COUPON_CODE" "IMAGE_GALLERY" "SOCIAL_BIO" "VIDEO_PREVIEW" "RESTAURANT_MENU"

Type of QR code

displayId
string^[a-zA-Z0-9\-_.~%]+$

Custom short URL ID (alphanumeric, hyphens, underscores)

qrRedirectUrl
string <uri>

Redirect URL (required for web type)

metadata
object

Custom metadata

settings
object

QR code settings

tags
Array of strings
folderId
string

Folder ID to place the QR code in (Coming Soon)

folderIds
Array of strings

Folder hierarchy (Coming Soon)

templateId
string

Template ID for QR code design. Can be found at app.qrtrac.com/pages/api. If not provided, default template is used.

baseUrl
string <uri> ^https?://.*/$

Custom domain base URL for QR codes. Must end with '/'. Prerequisite: Custom domain must be configured in the application. Can be found at app.qrtrac.com/pages/api. Example: If main domain is qrtrac.com and custom domain subdomain qr.qrtrac.com is configured, the baseUrl would be https://qr.qrtrac.com/. If not provided, default domain is used.

Responses

Request samples

Content type
application/json
Example

Redirect to any URL when scanned

{}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Bulk Create QR Codes

Create up to 25 QR codes in a single request. All QR codes in a request are grouped into one batch, and the response returns their IDs along with the batchId.

Each item in qrs accepts the same fields as Create QR Code, including qrType, displayId, templateId and baseUrl. A QR image is generated for every created QR code.

Design: Top-level metadata is applied to every QR code. If an item has a templateId, that template's design is used for that item instead. Items with neither get the default design.

Custom IDs: If any displayId is already taken, the whole request is rejected. Use Bulk Check QR ID Availability first.

Required Headers:

  • x-request-team-id: <team_id> - Team ID for the request context
  • x-request-client-id: <client_id> - Client ID from API menu
  • x-request-client-secret: <client_secret> - Client Secret from API menu
header Parameters
x-request-team-id
required
string

Team ID for the request context

x-request-client-id
required
string

Client ID obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

x-request-client-secret
required
string

Client Secret obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

Request Body schema: application/json
required
Array of objects (CreateQrRequest) [ 1 .. 25 ] items

QR codes to create (1-25)

title
string

Batch title

metadata
object

Design applied to every QR code in the batch, unless the item has a templateId

settings
object

Settings applied to every QR code in the batch

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "batchId": "Yb2mR8sTq1LxV0pZ"
}

Duplicate QR Code

Create a copy of an existing QR code with a new ID

path Parameters
id
required
string

QR code ID to duplicate

header Parameters
x-request-team-id
required
string

Team ID for the request context

x-request-client-id
required
string

Client ID obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

x-request-client-secret
required
string

Client Secret obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Duplicate QR Code by Quantity

Create up to 25 copies of an existing QR code in one request. Each copy gets its own ID and scan URL and keeps the source's content and design. Copies are named after the source with a running number.

To create a large run across several requests, pass startIndex and runTotal so the numbering in copy names continues between requests.

Availability: Duplicate by quantity must be enabled for your organization. Contact support@qrtrac.com to enable it.

Limits:

  • 25 copies per request
  • 250 copies per organization per day through the API (resets at 00:00 UTC)
  • Mini-site QR codes cannot be duplicated by quantity

Required Headers:

  • x-request-team-id: <team_id> - Team ID for the request context
  • x-request-client-id: <client_id> - Client ID from API menu
  • x-request-client-secret: <client_secret> - Client Secret from API menu
path Parameters
id
required
string

ID of the QR code to copy

header Parameters
x-request-team-id
required
string

Team ID for the request context

x-request-client-id
required
string

Client ID obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

x-request-client-secret
required
string

Client Secret obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

Request Body schema: application/json
quantity
required
integer [ 1 .. 25 ]

Number of copies to create

startIndex
integer >= 0
Default: 0

Position of this request's first copy within a larger run, used for copy names

runTotal
integer

Total copies in the whole run, used for copy names. Defaults to quantity, and must be at least quantity.

Responses

Request samples

Content type
application/json
Example
{
  • "quantity": 25,
  • "startIndex": 0,
  • "runTotal": 100
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Check QR ID Availability

Check if a custom QR display ID is available

path Parameters
id
required
string

Custom display ID to check

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": "string"
}

Bulk Check QR ID Availability

Check many custom display IDs at once. The response lists only the IDs that are already taken; any ID not in the list is available.

header Parameters
x-request-team-id
required
string

Team ID for the request context

x-request-client-id
required
string

Client ID obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

x-request-client-secret
required
string

Client Secret obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

Request Body schema: application/json
qrIds
required
Array of strings

Display IDs to check

Responses

Request samples

Content type
application/json
{
  • "qrIds": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ]
}

Update QR Code

Update an existing QR code

path Parameters
id
required
string
header Parameters
x-request-team-id
required
string

Team ID for the request context

x-request-client-id
required
string

Client ID obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

x-request-client-secret
required
string

Client Secret obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

Request Body schema: application/json
name
string

QR code name (defaults to "Untitled")

qrType
required
string
Enum: "WEB" "PDF" "VCARD" "MULTI_LOCALE" "APP_DOWNLOAD" "LINK_LIST" "SHORT_LINK" "COUPON_CODE" "IMAGE_GALLERY" "SOCIAL_BIO" "VIDEO_PREVIEW" "RESTAURANT_MENU"

Type of QR code

displayId
string^[a-zA-Z0-9\-_.~%]+$

Custom short URL ID (alphanumeric, hyphens, underscores)

qrRedirectUrl
string <uri>

Redirect URL (required for web type)

metadata
object

Custom metadata

settings
object

QR code settings

tags
Array of strings
folderId
string

Folder ID to place the QR code in (Coming Soon)

folderIds
Array of strings

Folder hierarchy (Coming Soon)

templateId
string

Template ID for QR code design. Can be found at app.qrtrac.com/pages/api. If not provided, default template is used.

baseUrl
string <uri> ^https?://.*/$

Custom domain base URL for QR codes. Must end with '/'. Prerequisite: Custom domain must be configured in the application. Can be found at app.qrtrac.com/pages/api. Example: If main domain is qrtrac.com and custom domain subdomain qr.qrtrac.com is configured, the baseUrl would be https://qr.qrtrac.com/. If not provided, default domain is used.

Responses

Request samples

Content type
application/json
{
  • "name": "Product Launch Landing Page",
  • "qrType": "WEB",
  • "displayId": "product-launch-2024",
  • "metadata": { },
  • "settings": { },
  • "tags": [
    ],
  • "folderId": "string",
  • "folderIds": [
    ],
  • "templateId": "qwrIYX8iLAuDHSBCiKZl",
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete QR Code

Soft delete a QR code (moves to deleted collection)

path Parameters
id
required
string
header Parameters
x-request-team-id
required
string

Team ID for the request context

x-request-client-id
required
string

Client ID obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

x-request-client-secret
required
string

Client Secret obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update QR Tags

Update tags for a specific QR code

path Parameters
id
required
string
header Parameters
x-request-team-id
required
string

Team ID for the request context

x-request-client-id
required
string

Client ID obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

x-request-client-secret
required
string

Client Secret obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

Request Body schema: application/json
tags
Array of strings

Responses

Request samples

Content type
application/json
{
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update QR Title

Update only the title/name of a QR code

path Parameters
id
required
string
header Parameters
x-request-team-id
required
string

Team ID for the request context

x-request-client-id
required
string

Client ID obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

x-request-client-secret
required
string

Client Secret obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

Request Body schema: application/json
title
required
string non-empty

Responses

Request samples

Content type
application/json
{
  • "title": "Summer Campaign - Homepage"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Bulk Add Tags

Add tags to many QR codes at once. Tags are appended to each QR code's existing tags. IDs that don't belong to your team are ignored.

header Parameters
x-request-team-id
required
string

Team ID for the request context

x-request-client-id
required
string

Client ID obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

x-request-client-secret
required
string

Client Secret obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

Request Body schema: application/json
qrIds
required
Array of strings
tags
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "qrIds": [
    ],
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ]
}

Bulk Delete QR Codes

Delete many QR codes at once. IDs that don't belong to your team are ignored.

header Parameters
x-request-team-id
required
string

Team ID for the request context

x-request-client-id
required
string

Client ID obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

x-request-client-secret
required
string

Client Secret obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

Request Body schema: application/json
qrIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "qrIds": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ]
}

Bulk Transfer QR Codes

Move QR codes from the team in x-request-team-id to another team in your organization. Scan URLs and analytics are kept.

Requires: The API credentials' owner must be an Owner or Admin of the source team. Every QR code must belong to the source team, otherwise nothing is transferred.

header Parameters
x-request-team-id
required
string

Team ID for the request context

x-request-client-id
required
string

Client ID obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

x-request-client-secret
required
string

Client Secret obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

Request Body schema: application/json
qrIds
required
Array of strings

QR code IDs to transfer

newTeamId
required
string

Destination team ID (must be in the same organization)

Responses

Request samples

Content type
application/json
{
  • "qrIds": [
    ],
  • "newTeamId": "Tm8ZqL3xV1cR"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get Paginated Team QR Codes

Retrieve QR codes with pagination, search, sorting, and folder filtering. This is the recommended endpoint for listing QR codes.

query Parameters
limit
integer [ 1 .. 100 ]
Default: 10

Number of items per page

page
integer >= 1
Default: 1

Page number

search
string

Search by name or displayId

sortBy
string
Default: "updatedAt"
Enum: "createdAt" "updatedAt" "name"

Field to sort by

sortOrder
string
Default: "desc"
Enum: "asc" "desc"

Sort direction

folderId
string

Filter by folder ID (Coming Soon)

header Parameters
x-request-team-id
required
string

Team ID for the request context

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get QR by ID

Retrieve a specific QR code by its ID

path Parameters
id
required
string

Responses

Request samples

curl -X GET https://api.qrtrac.com/api/qrs-api/teams/{id} \
  -H "x-request-team-id: <team_id>" \
  -H "x-request-client-id: <client_id>" \
  -H "x-request-client-secret: <client_secret>"

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get Team QRs Updated After Time

Retrieve QR codes updated after a specific timestamp

path Parameters
fromTime
required
integer

Unix timestamp in milliseconds

header Parameters
x-request-team-id
required
string

Team ID for the request context

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ]
}

Get All QRs Updated After Time

Retrieve all QR codes (across teams) updated after a specific timestamp

path Parameters
fromTime
required
integer

Unix timestamp in milliseconds

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ]
}

QR Code Design Templates

QR code design template management

Get QR Code Design Templates for Team

Retrieve all QR code design templates available for a team

header Parameters
x-request-team-id
required
string

Team ID for the request context

x-request-client-id
required
string

Client ID obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

x-request-client-secret
required
string

Client Secret obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

Responses

Request samples

curl -X GET https://api.qrtrac.com/api/qr-templates-api \
  -H "x-request-team-id: <team_id>" \
  -H "x-request-client-id: <client_id>" \
  -H "x-request-client-secret: <client_secret>"

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ]
}

Create QR Code Design Template

Save a QR code design as a template for your team. Use the returned id as templateId when creating QR codes.

metadata holds the design: size, colors, dot and corner styles, and logo. It uses the same format as a QR code's metadata.

header Parameters
x-request-team-id
required
string

Team ID for the request context

x-request-client-id
required
string

Client ID obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

x-request-client-secret
required
string

Client Secret obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

Request Body schema: application/json
title
string

Template name. Defaults to "Untitled".

metadata
object

QR code design options

Responses

Request samples

Content type
application/json
{
  • "title": "Acme brand",
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Duplicate QR Code Design Template

Create a copy of one of your team's templates. The copy's title gets a " Copy" suffix.

path Parameters
id
required
string

Template ID to copy

header Parameters
x-request-team-id
required
string

Team ID for the request context

x-request-client-id
required
string

Client ID obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

x-request-client-secret
required
string

Client Secret obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete QR Code Design Template

Delete a template. QR codes already created from it keep their design.

path Parameters
id
required
string

Template ID to delete

header Parameters
x-request-team-id
required
string

Team ID for the request context

x-request-client-id
required
string

Client ID obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

x-request-client-secret
required
string

Client Secret obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Digital Business Card Templates

Digital Business Card (vCard) designs as HTML, CSS and metadata

Get Digital Business Card Templates

Returns every Digital Business Card design, with the HTML, CSS and metadata needed to render a card in your own app exactly as the scan page shows it.

Rendering a card (for example in a web view):

  1. Add <base href="{assetBaseUrl}">, the stylesheets links in order, and <style>{baseCss}{template.css}</style>.
  2. Place template.html inside <div id="qrDetails" class="qrDetails">.
  3. Set the CSS variable --vt-c on #vcard to the card's theme colour, fill the text elements (#vcard-name, #vcard-designation, #vcard-company, #vcard-summary and the data-vt slots), set or remove #vcard-profile-image and #company-logo, and append one partials.contactRows entry per contact detail to #contactLinks.

Templates change rarely. Responses carry an ETag and Cache-Control: private, max-age=3600, and data.version changes whenever any template changes, so cache the result and send If-None-Match when refreshing.

The id of each template is the value to send as templateId when creating a Digital Business Card QR code.

header Parameters
x-request-team-id
required
string

Team ID for the request context

x-request-client-id
required
string

Client ID obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

x-request-client-secret
required
string

Client Secret obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

Responses

Request samples

curl -X GET https://api.qrtrac.com/api/vcard-templates-api \
  --compressed \
  -H "x-request-team-id: <team_id>" \
  -H "x-request-client-id: <client_id>" \
  -H "x-request-client-secret: <client_secret>"

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get Digital Business Card Template

Returns one Digital Business Card design with the shared CSS and partials needed to render it on its own.

path Parameters
id
required
integer [ 1 .. 50 ]

Template ID

header Parameters
x-request-team-id
required
string

Team ID for the request context

x-request-client-id
required
string

Client ID obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

x-request-client-secret
required
string

Client Secret obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

Responses

Request samples

curl -X GET https://api.qrtrac.com/api/vcard-templates-api/5 \
  --compressed \
  -H "x-request-team-id: <team_id>" \
  -H "x-request-client-id: <client_id>" \
  -H "x-request-client-secret: <client_secret>"

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Analytics

QR code scan analytics and tracking data

Get QR Code Scan Analytics

Retrieve detailed scan analytics data for a specific QR code by its ID.

Required Headers:

  • x-request-team-id: <team_id> - Team ID for the request context
  • x-request-client-id: <client_id> - Client ID from API menu
  • x-request-client-secret: <client_secret> - Client Secret from API menu

Note: For total scan counts, use the /analytics-api/overviews endpoint.

path Parameters
id
required
string

QR code ID (qrId) to get scan data for

header Parameters
x-request-team-id
required
string

Team ID for the request context

x-request-client-id
required
string

Client ID obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

x-request-client-secret
required
string

Client Secret obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

Responses

Request samples

curl -X GET https://api.qrtrac.com/api/analytics-api/detailed/{qrId} \
  -H "x-request-team-id: <team_id>" \
  -H "x-request-client-id: <client_id>" \
  -H "x-request-client-secret: <client_secret>"

Response samples

Content type
application/json

Example response showing array of scan events

{
  • "success": true,
  • "data": [
    ]
}

Bulk fetch QR Code Analytics

Retrieve scan analytics data for multiple QR codes within a specified time range.

Required Headers:

  • x-request-team-id: <team_id> - Team ID for the request context
  • x-request-client-id: <client_id> - Client ID from API menu
  • x-request-client-secret: <client_secret> - Client Secret from API menu

Time Format:

  • startTime and endTime must be provided as epoch timestamps in milliseconds.

Note: For total scan counts, use the /analytics-api/overviews endpoint.

header Parameters
x-request-team-id
required
string

Team ID for the request context

x-request-client-id
required
string

Client ID obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

x-request-client-secret
required
string

Client Secret obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

Request Body schema: application/json
qrIds
required
Array of strings

Array of QR code IDs to fetch analytics for

startTime
required
integer <int64>

Start time in epoch milliseconds

endTime
required
integer <int64>

End time in epoch milliseconds

Responses

Request samples

Content type
application/json

Fetch scan data for multiple QR codes between two timestamps

{
  • "qrIds": [
    ],
  • "startTime": 1704067200000,
  • "endTime": 1735689600000
}

Response samples

Content type
application/json

Example response showing array of scan events for multiple QR codes

{
  • "success": true,
  • "data": [
    ]
}

Get Total Scans Overview

Retrieve total scan counts for multiple QR codes. This endpoint returns aggregate scan data without requiring time range parameters.

Required Headers:

  • x-request-team-id: <team_id> - Team ID for the request context
  • x-request-client-id: <client_id> - Client ID from API menu
  • x-request-client-secret: <client_secret> - Client Secret from API menu

Note: Unique scans are computed client-side from scan data and are not provided via API endpoints.

header Parameters
x-request-team-id
required
string

Team ID for the request context

x-request-client-id
required
string

Client ID obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

x-request-client-secret
required
string

Client Secret obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

Request Body schema: application/json
qrIds
required
Array of strings

Array of QR code IDs to fetch total scans for

Responses

Request samples

Content type
application/json

Fetch total scan counts for multiple QR codes

{
  • "qrIds": [
    ]
}

Response samples

Content type
application/json

Example response showing scan and lead analytics for QR codes

{
  • "success": true,
  • "data": [
    ]
}

Get Organization-wide Scans

Retrieve every scan event across all teams in your organization within a time range. Defaults to the last 7 days if no range is given.

Requires: The API credentials' owner must be an Owner or Admin of at least one team. x-request-team-id must still be a team in your organization, but results are not limited to that team.

Tip: Keep the time range short for busy organizations, because every matching scan is returned in one response.

header Parameters
x-request-team-id
required
string

Team ID for the request context

x-request-client-id
required
string

Client ID obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

x-request-client-secret
required
string

Client Secret obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

Request Body schema: application/json
startTime
integer <int64>

Start of the range in epoch milliseconds. Defaults to 7 days before endTime.

endTime
integer <int64>

End of the range in epoch milliseconds. Defaults to now.

Responses

Request samples

Content type
application/json
{
  • "startTime": 1767225600000,
  • "endTime": 1767830400000
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ]
}

Teams

Team management operations

Get All Teams

Retrieve all teams the authenticated user belongs to

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ]
}

Create Team

Create a new team within the organization

Request Body schema: application/json
name
required
string

Team name

Responses

Request samples

Content type
application/json
{
  • "name": "Sales & Marketing"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get Team by ID

Retrieve a specific team with its members

path Parameters
id
required
string
header Parameters
x-request-team-id
required
string

Team ID for the request context

x-request-client-id
required
string

Client ID obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

x-request-client-secret
required
string

Client Secret obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update Team

Update team name (requires Admin or Owner role)

path Parameters
id
required
string
header Parameters
x-request-team-id
required
string

Team ID for the request context

x-request-client-id
required
string

Client ID obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

x-request-client-secret
required
string

Client Secret obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

Request Body schema: application/json
name
required
string

New team name

Responses

Request samples

Content type
application/json
{
  • "name": "Sales & Marketing - Q4"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update Domain Preferences

Update team's default domain and allowed domains

path Parameters
id
required
string
header Parameters
x-request-team-id
required
string

Team ID for the request context

x-request-client-id
required
string

Client ID obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

x-request-client-secret
required
string

Client Secret obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

Request Body schema: application/json
defaultDomain
required
string

Default domain for QR codes

domains
required
Array of strings

List of allowed domains

Responses

Request samples

Content type
application/json
{
  • "defaultDomain": "qr.acmecorp.com",
  • "domains": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Team Members

Team member management and operations

Add Team Member

Add a new member to a team or update existing member's role. If the user doesn't exist, creates a new user and sends an invite email.

path Parameters
id
required
string
header Parameters
x-request-team-id
required
string

Team ID for the request context

x-request-client-id
required
string

Client ID obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

x-request-client-secret
required
string

Client Secret obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

Request Body schema: application/json
name
required
string

Member's full name

email
required
string <email>

Member's email address

role
required
string
Enum: "admin" "editor" "viewer"

Member's role (owner cannot be assigned)

Responses

Request samples

Content type
application/json
{
  • "name": "Sarah Johnson",
  • "email": "sarah.johnson@acmecorp.com",
  • "role": "editor"
}

Response samples

Content type
application/json
{
  • "success": true
}

Bulk Add Member to Teams

Add a member to multiple teams at once

Request Body schema: application/json
name
required
string

Member's full name

email
required
string <email>
required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "name": "Michael Chen",
  • "email": "michael.chen@acmecorp.com",
  • "teams": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true
}

Activate Team Member

Reactivate a paused member's access to the team

path Parameters
id
required
string
email
required
string <email>
header Parameters
x-request-team-id
required
string

Team ID for the request context

x-request-client-id
required
string

Client ID obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

x-request-client-secret
required
string

Client Secret obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Pause Team Member

Temporarily pause a member's access to the team

path Parameters
id
required
string
email
required
string <email>
header Parameters
x-request-team-id
required
string

Team ID for the request context

x-request-client-id
required
string

Client ID obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

x-request-client-secret
required
string

Client Secret obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Change Member Role

Update a member's role in the team

path Parameters
id
required
string
email
required
string <email>
header Parameters
x-request-team-id
required
string

Team ID for the request context

x-request-client-id
required
string

Client ID obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

x-request-client-secret
required
string

Client Secret obtained from app.qrtrac.com/pages/api. Owner/Admin role and Business Plus plan or higher required.

Request Body schema: application/json
role
required
string
Enum: "admin" "editor" "viewer"

New role (owner cannot be assigned)

Responses

Request samples

Content type
application/json
{
  • "role": "admin"
}

Response samples

Content type
application/json
{
  • "success": true
}

Resend Invite Email

Resend the invitation email to a pending member

path Parameters
email
required
string <email>

Responses

Response samples

Content type
application/json
{
  • "success": true
}