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.
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:
The QRTRAC API is organized into the following functional areas:
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.
Create, duplicate, list, and delete reusable QR code design templates, then apply them when creating QR codes via templateId.
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.
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.
Create and manage teams within your organization, configure domain preferences, and control access with granular permissions.
Invite, activate, pause, and manage team members with role-based permissions. Support for bulk member operations across multiple teams.
Follow these steps to start using the QRTRAC API:
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.
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.
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.
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.
Browse the available endpoints in the sidebar to discover all available operations. Each endpoint includes detailed request/response examples.
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.
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).
https://mcp.qrtrac.com/mcpAI 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:
.vcf file directly into iOS (iPhone Contacts) and Android address books.update_vcard_qr_code without reprinting the physical QR code.upload_image), and custom domain redirect URLs.| 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 |
All API responses follow a consistent format:
{
"success": true,
"data": { ... }
}
Error responses include a message field:
{
"success": false,
"message": "Error description"
}
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 allowedX-RateLimit-Remaining: Number of requests remainingX-RateLimit-Reset: Time when the rate limit resetsAPI access is available on the following plans with increasing request limits:
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.
For additional help, questions, or to report issues, please contact our support team.
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 contextx-request-client-id: <client_id> - Client ID from API menux-request-client-secret: <client_secret> - Client Secret from API menuNote: 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
| 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 |
| 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. |
| 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 |
Redirect to any URL when scanned
{- "name": "My Website",
- "qrType": "WEB",
}{- "success": true,
- "data": {
- "id": "string",
- "displayId": "string",
- "name": "string",
- "qrType": "string",
- "teamId": "string",
- "orgId": "string",
- "qrRedirectUrl": "string",
- "qrImageUrl": "string",
- "qrImageHash": "string",
- "metadata": { },
- "settings": { },
- "tags": [
- "string"
], - "folderId": "string",
- "folderIds": [
- "string"
], - "batchId": "string",
- "deleted": true,
- "createdAt": 0,
- "createdBy": "string",
- "updatedAt": 0,
- "updatedBy": "string"
}
}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 contextx-request-client-id: <client_id> - Client ID from API menux-request-client-secret: <client_secret> - Client Secret from API menu| 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. |
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 |
| settings | object Settings applied to every QR code in the batch |
{- "title": "Store flyers",
- "qrs": [
- {
- "name": "Store 2",
- "qrType": "WEB",
- "displayId": "acme-store-2"
}
]
}{- "success": true,
- "data": [
- "k3Xb9q",
- "acme-store-2"
], - "batchId": "Yb2mR8sTq1LxV0pZ"
}Create a copy of an existing QR code with a new ID
| id required | string QR code ID to duplicate |
| 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. |
{- "success": true,
- "data": {
- "id": "string",
- "displayId": "string",
- "name": "string",
- "qrType": "string",
- "teamId": "string",
- "orgId": "string",
- "qrRedirectUrl": "string",
- "qrImageUrl": "string",
- "qrImageHash": "string",
- "metadata": { },
- "settings": { },
- "tags": [
- "string"
], - "folderId": "string",
- "folderIds": [
- "string"
], - "batchId": "string",
- "deleted": true,
- "createdAt": 0,
- "createdBy": "string",
- "updatedAt": 0,
- "updatedBy": "string"
}
}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:
Required Headers:
x-request-team-id: <team_id> - Team ID for the request contextx-request-client-id: <client_id> - Client ID from API menux-request-client-secret: <client_secret> - Client Secret from API menu| id required | string ID of the QR code to copy |
| 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. |
| 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": 25,
- "startIndex": 0,
- "runTotal": 100
}{- "success": true,
- "data": {
- "batchId": "Hn4cQ7wZp2KsE9tY",
- "requested": 3,
- "created": 3,
- "failed": 0,
- "ids": [
- "p8Ld2x",
- "Q4mZs7",
- "t1Vb6k"
], - "dailyRemaining": 247
}
}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.
| 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. |
| qrIds required | Array of strings Display IDs to check |
{- "qrIds": [
- "acme-store-1",
- "acme-store-2",
- "acme-store-3"
]
}{- "success": true,
- "data": [
- "acme-store-2"
]
}Update an existing QR code
| id required | string |
| 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. |
| 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 |
{- "name": "Product Launch Landing Page",
- "qrType": "WEB",
- "displayId": "product-launch-2024",
- "metadata": { },
- "settings": { },
- "tags": [
- "string"
], - "folderId": "string",
- "folderIds": [
- "string"
], - "templateId": "qwrIYX8iLAuDHSBCiKZl",
}{- "success": true,
- "data": {
- "id": "string",
- "displayId": "string",
- "name": "string",
- "qrType": "string",
- "teamId": "string",
- "orgId": "string",
- "qrRedirectUrl": "string",
- "qrImageUrl": "string",
- "qrImageHash": "string",
- "metadata": { },
- "settings": { },
- "tags": [
- "string"
], - "folderId": "string",
- "folderIds": [
- "string"
], - "batchId": "string",
- "deleted": true,
- "createdAt": 0,
- "createdBy": "string",
- "updatedAt": 0,
- "updatedBy": "string"
}
}Soft delete a QR code (moves to deleted collection)
| id required | string |
| 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. |
{- "success": true,
- "data": {
- "id": "string",
- "displayId": "string",
- "name": "string",
- "qrType": "string",
- "teamId": "string",
- "orgId": "string",
- "qrRedirectUrl": "string",
- "qrImageUrl": "string",
- "qrImageHash": "string",
- "metadata": { },
- "settings": { },
- "tags": [
- "string"
], - "folderId": "string",
- "folderIds": [
- "string"
], - "batchId": "string",
- "deleted": true,
- "createdAt": 0,
- "createdBy": "string",
- "updatedAt": 0,
- "updatedBy": "string"
}
}Update tags for a specific QR code
| id required | string |
| 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. |
| tags | Array of strings |
{- "tags": [
- "marketing",
- "product-launch",
- "q4-2024"
]
}{- "success": true,
- "data": {
- "id": "string",
- "displayId": "string",
- "name": "string",
- "qrType": "string",
- "teamId": "string",
- "orgId": "string",
- "qrRedirectUrl": "string",
- "qrImageUrl": "string",
- "qrImageHash": "string",
- "metadata": { },
- "settings": { },
- "tags": [
- "string"
], - "folderId": "string",
- "folderIds": [
- "string"
], - "batchId": "string",
- "deleted": true,
- "createdAt": 0,
- "createdBy": "string",
- "updatedAt": 0,
- "updatedBy": "string"
}
}Update only the title/name of a QR code
| id required | string |
| 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. |
| title required | string non-empty |
{- "title": "Summer Campaign - Homepage"
}{- "success": true,
- "data": {
- "id": "string",
- "displayId": "string",
- "name": "string",
- "qrType": "string",
- "teamId": "string",
- "orgId": "string",
- "qrRedirectUrl": "string",
- "qrImageUrl": "string",
- "qrImageHash": "string",
- "metadata": { },
- "settings": { },
- "tags": [
- "string"
], - "folderId": "string",
- "folderIds": [
- "string"
], - "batchId": "string",
- "deleted": true,
- "createdAt": 0,
- "createdBy": "string",
- "updatedAt": 0,
- "updatedBy": "string"
}
}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.
| 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. |
| qrIds required | Array of strings |
| tags required | Array of strings |
{- "qrIds": [
- "k3Xb9q",
- "acme-store-2"
], - "tags": [
- "spring-campaign"
]
}{- "success": true,
- "data": [
- {
- "id": "string",
- "displayId": "string",
- "name": "string",
- "qrType": "string",
- "teamId": "string",
- "orgId": "string",
- "qrRedirectUrl": "string",
- "qrImageUrl": "string",
- "qrImageHash": "string",
- "metadata": { },
- "settings": { },
- "tags": [
- "string"
], - "folderId": "string",
- "folderIds": [
- "string"
], - "batchId": "string",
- "deleted": true,
- "createdAt": 0,
- "createdBy": "string",
- "updatedAt": 0,
- "updatedBy": "string"
}
]
}Delete many QR codes at once. IDs that don't belong to your team are ignored.
| 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. |
| qrIds required | Array of strings |
{- "qrIds": [
- "k3Xb9q",
- "acme-store-2"
]
}{- "success": true,
- "data": [
- {
- "id": "string",
- "displayId": "string",
- "name": "string",
- "qrType": "string",
- "teamId": "string",
- "orgId": "string",
- "qrRedirectUrl": "string",
- "qrImageUrl": "string",
- "qrImageHash": "string",
- "metadata": { },
- "settings": { },
- "tags": [
- "string"
], - "folderId": "string",
- "folderIds": [
- "string"
], - "batchId": "string",
- "deleted": true,
- "createdAt": 0,
- "createdBy": "string",
- "updatedAt": 0,
- "updatedBy": "string"
}
]
}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.
| 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. |
| qrIds required | Array of strings QR code IDs to transfer |
| newTeamId required | string Destination team ID (must be in the same organization) |
{- "qrIds": [
- "k3Xb9q",
- "acme-store-2"
], - "newTeamId": "Tm8ZqL3xV1cR"
}{- "success": true,
- "data": {
- "transferredCount": 0,
- "qrIds": [
- "string"
]
}
}Retrieve QR codes with pagination, search, sorting, and folder filtering. This is the recommended endpoint for listing QR codes.
| 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) |
| x-request-team-id required | string Team ID for the request context |
{- "success": true,
- "data": {
- "qrs": [
- {
- "id": "string",
- "displayId": "string",
- "name": "string",
- "qrType": "string",
- "teamId": "string",
- "orgId": "string",
- "qrRedirectUrl": "string",
- "qrImageUrl": "string",
- "qrImageHash": "string",
- "metadata": { },
- "settings": { },
- "tags": [
- "string"
], - "folderId": "string",
- "folderIds": [
- "string"
], - "batchId": "string",
- "deleted": true,
- "createdAt": 0,
- "createdBy": "string",
- "updatedAt": 0,
- "updatedBy": "string"
}
], - "totalCount": 0,
- "page": 0,
- "limit": 0
}
}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>"
{- "success": true,
- "data": {
- "id": "string",
- "displayId": "string",
- "name": "string",
- "qrType": "string",
- "teamId": "string",
- "orgId": "string",
- "qrRedirectUrl": "string",
- "qrImageUrl": "string",
- "qrImageHash": "string",
- "metadata": { },
- "settings": { },
- "tags": [
- "string"
], - "folderId": "string",
- "folderIds": [
- "string"
], - "batchId": "string",
- "deleted": true,
- "createdAt": 0,
- "createdBy": "string",
- "updatedAt": 0,
- "updatedBy": "string"
}
}Retrieve QR codes updated after a specific timestamp
| fromTime required | integer Unix timestamp in milliseconds |
| x-request-team-id required | string Team ID for the request context |
{- "success": true,
- "data": [
- {
- "id": "string",
- "displayId": "string",
- "name": "string",
- "qrType": "string",
- "teamId": "string",
- "orgId": "string",
- "qrRedirectUrl": "string",
- "qrImageUrl": "string",
- "qrImageHash": "string",
- "metadata": { },
- "settings": { },
- "tags": [
- "string"
], - "folderId": "string",
- "folderIds": [
- "string"
], - "batchId": "string",
- "deleted": true,
- "createdAt": 0,
- "createdBy": "string",
- "updatedAt": 0,
- "updatedBy": "string"
}
]
}Retrieve all QR codes (across teams) updated after a specific timestamp
| fromTime required | integer Unix timestamp in milliseconds |
{- "success": true,
- "data": [
- {
- "id": "string",
- "displayId": "string",
- "name": "string",
- "qrType": "string",
- "teamId": "string",
- "orgId": "string",
- "qrRedirectUrl": "string",
- "qrImageUrl": "string",
- "qrImageHash": "string",
- "metadata": { },
- "settings": { },
- "tags": [
- "string"
], - "folderId": "string",
- "folderIds": [
- "string"
], - "batchId": "string",
- "deleted": true,
- "createdAt": 0,
- "createdBy": "string",
- "updatedAt": 0,
- "updatedBy": "string"
}
]
}Retrieve all QR code design templates available for a team
| 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. |
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>"
{- "success": true,
- "data": [
- {
- "id": "string",
- "title": "string",
- "teamId": "string",
- "orgId": "string",
- "metadata": { },
- "createdAt": 0,
- "createdBy": "string",
- "updatedAt": 0
}
]
}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.
| 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. |
| title | string Template name. Defaults to "Untitled". |
| metadata | object QR code design options |
{- "title": "Acme brand",
- "metadata": {
- "width": 720,
- "height": 720,
- "margin": 10,
- "dotsOptions": {
- "type": "rounded",
- "color": "#1e3a8a"
}, - "cornersSquareOptions": {
- "type": "extra-rounded",
- "color": "#1e3a8a"
}, - "backgroundOptions": {
- "color": "#ffffff"
}
}
}{- "success": true,
- "data": {
- "id": "string",
- "title": "string",
- "teamId": "string",
- "orgId": "string",
- "metadata": { },
- "createdAt": 0,
- "createdBy": "string",
- "updatedAt": 0
}
}Create a copy of one of your team's templates. The copy's title gets a " Copy" suffix.
| id required | string Template ID to copy |
| 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. |
{- "success": true,
- "data": {
- "id": "string",
- "title": "string",
- "teamId": "string",
- "orgId": "string",
- "metadata": { },
- "createdAt": 0,
- "createdBy": "string",
- "updatedAt": 0
}
}Delete a template. QR codes already created from it keep their design.
| id required | string Template ID to delete |
| 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. |
{- "success": true,
- "data": {
- "id": "string",
- "title": "string",
- "teamId": "string",
- "orgId": "string",
- "metadata": { },
- "createdAt": 0,
- "createdBy": "string",
- "updatedAt": 0
}
}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):
<base href="{assetBaseUrl}">, the stylesheets links in order, and <style>{baseCss}{template.css}</style>.template.html inside <div id="qrDetails" class="qrDetails">.--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.
| 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. |
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>"
{- "success": true,
- "data": {
- "version": "4f345454589a",
- "baseCss": "string",
- "partials": {
- "contactRows": {
- "phone": "string",
- "email": "string",
- "website": "string",
- "address": "string",
- "note": "string"
}, - "socialLink": "string",
- "address": "string"
}, - "categories": [
- {
- "key": "professional",
- "label": "Professional"
}
], - "professions": [
- {
- "key": "healthcare",
- "label": "Healthcare",
- "keywords": [
- "doctor",
- "dentist",
- "nurse"
]
}
], - "popularTemplateIds": [
- 3,
- 9,
- 6,
- 10,
- 16
], - "templates": [
- {
- "id": 5,
- "name": "Executive",
- "description": "Deep tinted header, serif name and a framed portrait.",
- "bestFor": "Leadership, advisors, board members",
- "categories": [
- "professional"
], - "professions": [
- "legal",
- "finance"
], - "photo": "hero",
- "worksWithoutPhoto": true,
- "dark": true,
- "html": "string",
- "css": "string"
}
]
}
}Returns one Digital Business Card design with the shared CSS and partials needed to render it on its own.
| id required | integer [ 1 .. 50 ] Template ID |
| 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. |
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>"
{- "success": true,
- "data": {
- "version": "4f345454589a",
- "baseCss": "string",
- "partials": {
- "contactRows": {
- "phone": "string",
- "email": "string",
- "website": "string",
- "address": "string",
- "note": "string"
}, - "socialLink": "string",
- "address": "string"
}, - "template": {
- "id": 5,
- "name": "Executive",
- "description": "Deep tinted header, serif name and a framed portrait.",
- "bestFor": "Leadership, advisors, board members",
- "categories": [
- "professional"
], - "professions": [
- "legal",
- "finance"
], - "photo": "hero",
- "worksWithoutPhoto": true,
- "dark": true,
- "html": "string",
- "css": "string"
}
}
}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 contextx-request-client-id: <client_id> - Client ID from API menux-request-client-secret: <client_secret> - Client Secret from API menuNote: For total scan counts, use the /analytics-api/overviews endpoint.
| id required | string QR code ID (qrId) to get scan data for |
| 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. |
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>"
Example response showing array of scan events
{- "success": true,
- "data": [
- {
- "id": "Xq1aZ7pLm2Kd",
- "qrId": "dgj",
- "qrType": "WEB",
- "ip": "203.0.113.24",
- "device": {
- "vendor": "Apple",
- "model": "iPhone",
- "type": "mobile"
}, - "os": {
- "name": "iOS",
- "version": "17.0"
}, - "browser": {
- "name": "Mobile Safari",
- "version": "17.0",
- "major": "17"
}, - "address": {
- "city": "San Francisco",
- "state": "California",
- "country": "United States",
- "postcode": "94103"
}, - "timezone": "America/Los_Angeles",
- "createdAt": 1768412112787
}, - {
- "id": "Rt8bN3vYc6Wh",
- "qrId": "dgj",
- "qrType": "WEB",
- "ip": "198.51.100.7",
- "device": { },
- "os": {
- "name": "Mac OS",
- "version": "10.15.7"
}, - "browser": {
- "name": "Safari",
- "version": "17.2",
- "major": "17"
}, - "address": {
- "city": "New York",
- "state": "New York",
- "country": "United States",
- "postcode": "10001"
}, - "timezone": "America/New_York",
- "createdAt": 1768412000000
}
]
}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 contextx-request-client-id: <client_id> - Client ID from API menux-request-client-secret: <client_secret> - Client Secret from API menuTime Format:
startTime and endTime must be provided as epoch timestamps in milliseconds.Note: For total scan counts, use the /analytics-api/overviews endpoint.
| 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. |
| 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 |
Fetch scan data for multiple QR codes between two timestamps
{- "qrIds": [
- "qr_abc123",
- "qr_def456",
- "qr_ghi789"
], - "startTime": 1704067200000,
- "endTime": 1735689600000
}Example response showing array of scan events for multiple QR codes
{- "success": true,
- "data": [
- {
- "id": "Xq1aZ7pLm2Kd",
- "qrId": "qr_abc123",
- "qrType": "WEB",
- "ip": "203.0.113.24",
- "device": {
- "vendor": "Apple",
- "model": "iPhone",
- "type": "mobile"
}, - "os": {
- "name": "iOS",
- "version": "17.0"
}, - "browser": {
- "name": "Mobile Safari",
- "version": "17.0",
- "major": "17"
}, - "address": {
- "city": "San Francisco",
- "state": "California",
- "country": "United States",
- "postcode": "94103"
}, - "timezone": "America/Los_Angeles",
- "createdAt": 1768412112787
}, - {
- "id": "Rt8bN3vYc6Wh",
- "qrId": "qr_abc123",
- "qrType": "WEB",
- "ip": "198.51.100.7",
- "device": { },
- "os": {
- "name": "Mac OS",
- "version": "10.15.7"
}, - "browser": {
- "name": "Safari",
- "version": "17.2",
- "major": "17"
}, - "address": {
- "city": "New York",
- "state": "New York",
- "country": "United States",
- "postcode": "10001"
}, - "timezone": "America/New_York",
- "createdAt": 1768412000000
}, - {
- "id": "Gm4sQ9eTx0Jf",
- "qrId": "qr_def456",
- "qrType": "WEB",
- "ip": "192.0.2.45",
- "device": {
- "vendor": "Samsung",
- "model": "SM-S918B",
- "type": "mobile"
}, - "os": {
- "name": "Android",
- "version": "14"
}, - "browser": {
- "name": "Chrome",
- "version": "121.0.6167.143",
- "major": "121"
}, - "address": {
- "city": "London",
- "state": "England",
- "country": "United Kingdom",
- "postcode": "EC1A 1BB"
}, - "timezone": "Europe/London",
- "createdAt": 1768411900000
}
]
}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 contextx-request-client-id: <client_id> - Client ID from API menux-request-client-secret: <client_secret> - Client Secret from API menuNote: Unique scans are computed client-side from scan data and are not provided via API endpoints.
| 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. |
| qrIds required | Array of strings Array of QR code IDs to fetch total scans for |
Fetch total scan counts for multiple QR codes
{- "qrIds": [
- "qr_abc123",
- "qr_def456",
- "qr_ghi789"
]
}Example response showing scan and lead analytics for QR codes
{- "success": true,
- "data": [
- {
- "id": "dgj",
- "leadsTodayCount": 0,
- "totalLeadsCount": 0,
- "createdAt": 1766771093365,
- "leadsUpdatedAt": 1766771093365,
- "leadsTodayDate": "12/26/2025",
- "leadsYesterdayCount": 0,
- "yesterdayScans": 1,
- "todayDate": "1/14/2026",
- "totalScans": 9,
- "todayScans": 3,
- "updatedAt": 1768412112787
}
]
}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.
| 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. |
| startTime | integer <int64> Start of the range in epoch milliseconds. Defaults to 7 days before |
| endTime | integer <int64> End of the range in epoch milliseconds. Defaults to now. |
{- "startTime": 1767225600000,
- "endTime": 1767830400000
}{- "success": true,
- "data": [
- {
- "id": "string",
- "qrId": "string",
- "orgId": "string",
- "teamId": "string",
- "qrType": "string",
- "ip": "string",
- "latitude": 0,
- "longitude": 0,
- "device": {
- "vendor": "Apple",
- "model": "iPhone",
- "type": "mobile"
}, - "os": {
- "name": "iOS",
- "version": "17.0"
}, - "browser": {
- "name": "Mobile Safari",
- "version": "string",
- "major": "string"
}, - "address": {
- "address": "string",
- "suburb": "string",
- "city": "string",
- "county": "string",
- "state": "string",
- "country": "string",
- "postcode": "string"
}, - "timezone": "America/Los_Angeles",
- "source": "string",
- "createdAt": 0
}
]
}{- "success": true,
- "data": [
- {
- "id": "string",
- "name": "string",
- "orgId": "string",
- "defaultDomain": "string",
- "domains": [
- "string"
], - "members": [
- {
- "name": "string",
- "email": "user@example.com",
- "role": "owner"
}
], - "createdAt": 0,
- "createdBy": "string",
- "updatedAt": 0,
- "updatedBy": "string"
}
]
}Create a new team within the organization
| name required | string Team name |
{- "name": "Sales & Marketing"
}{- "success": true,
- "data": {
- "id": "string",
- "name": "string",
- "orgId": "string",
- "defaultDomain": "string",
- "domains": [
- "string"
], - "members": [
- {
- "name": "string",
- "email": "user@example.com",
- "role": "owner"
}
], - "createdAt": 0,
- "createdBy": "string",
- "updatedAt": 0,
- "updatedBy": "string"
}
}Retrieve a specific team with its members
| id required | string |
| 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. |
{- "success": true,
- "data": {
- "id": "string",
- "name": "string",
- "orgId": "string",
- "defaultDomain": "string",
- "domains": [
- "string"
], - "members": [
- {
- "name": "string",
- "email": "user@example.com",
- "role": "owner"
}
], - "createdAt": 0,
- "createdBy": "string",
- "updatedAt": 0,
- "updatedBy": "string"
}
}Update team name (requires Admin or Owner role)
| id required | string |
| 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. |
| name required | string New team name |
{- "name": "Sales & Marketing - Q4"
}{- "success": true,
- "data": {
- "id": "string",
- "name": "string",
- "orgId": "string",
- "defaultDomain": "string",
- "domains": [
- "string"
], - "members": [
- {
- "name": "string",
- "email": "user@example.com",
- "role": "owner"
}
], - "createdAt": 0,
- "createdBy": "string",
- "updatedAt": 0,
- "updatedBy": "string"
}
}Update team's default domain and allowed domains
| id required | string |
| 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. |
| defaultDomain required | string Default domain for QR codes |
| domains required | Array of strings List of allowed domains |
{- "defaultDomain": "qr.acmecorp.com",
- "domains": [
- "qr.acmecorp.com",
- "campaign.acmecorp.com",
- "promo.acmecorp.com"
]
}{- "success": true,
- "data": {
- "id": "string",
- "name": "string",
- "orgId": "string",
- "defaultDomain": "string",
- "domains": [
- "string"
], - "members": [
- {
- "name": "string",
- "email": "user@example.com",
- "role": "owner"
}
], - "createdAt": 0,
- "createdBy": "string",
- "updatedAt": 0,
- "updatedBy": "string"
}
}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.
| id required | string |
| 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. |
| 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) |
{- "name": "Sarah Johnson",
- "email": "sarah.johnson@acmecorp.com",
- "role": "editor"
}{- "success": true
}Add a member to multiple teams at once
| name required | string Member's full name |
| email required | string <email> |
required | Array of objects |
{- "name": "Michael Chen",
- "email": "michael.chen@acmecorp.com",
- "teams": [
- {
- "teamId": "team_abc123",
- "role": "admin"
}, - {
- "teamId": "team_def456",
- "role": "editor"
}
]
}{- "success": true
}Reactivate a paused member's access to the team
| id required | string |
| email required | string <email> |
| 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. |
{- "success": true
}Temporarily pause a member's access to the team
| id required | string |
| email required | string <email> |
| 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. |
{- "success": true
}Update a member's role in the team
| id required | string |
| email required | string <email> |
| 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. |
| role required | string Enum: "admin" "editor" "viewer" New role (owner cannot be assigned) |
{- "role": "admin"
}{- "success": true
}