API Reference

RESTful API for integrating DinoQ into your applications

Authentication

API Tokens

API access is available on Pro and Business plans

Generating a Token

1. Navigate to Dashboard → API Tokens
2. Click "Generate New Token"
3. Give your token a name
4. Copy the token immediately (it won't be shown again)

Using Your Token

Include your API token in the Authorization header:

Authorization: Bearer dq_your_token_here

Rate Limits

Pro Plan: 1,000 requests per day
Business Plan: 5,000 requests per day
Rate limit resets daily at midnight UTC

Base URL

https://api.dinoq.in/v1

Endpoints

POST

/qr

Create a new QR code

Body Parameters

ParameterTypeDescription

namestringQR code name

typestringREDIRECT, FILE, or VCARD

urlstringDestination URL (for REDIRECT)

expiresAtstringISO date (optional)

maxScansnumberMax scans before expiry (optional)

GET

/qr

List all QR codes

Query Parameters

pagenumberPage number (default: 1)

limitnumberItems per page (default: 20)

typestringFilter by type

Example Response

{
  "data": [
    {
      "id": "clx1234567890",
      "shortCode": "abc12345",
      "name": "My QR Code",
      "type": "REDIRECT",
      "status": "ACTIVE",
      "scanCount": 42,
      "createdAt": "2024-01-01T00:00:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 50,
    "pages": 3
  }
}

GET

/qr/:id

Get QR code details

GET /v1/qr/clx1234567890

Response:
{
  "id": "clx1234567890",
  "shortCode": "abc12345",
  "name": "My QR Code",
  "type": "REDIRECT",
  "status": "ACTIVE",
  "config": {
    "url": "https://example.com"
  },
  "scanCount": 42,
  "editCount": 2,
  "createdAt": "2024-01-01T00:00:00.000Z",
  "updatedAt": "2024-01-02T00:00:00.000Z"
}

PUT

/qr/:id

Update QR code

PUT /v1/qr/clx1234567890
Content-Type: application/json

{
  "url": "https://newdestination.com"
}

Response:
{
  "message": "QR code updated successfully",
  "editCount": 3
}

DELETE

/qr/:id

Delete QR code

DELETE /v1/qr/clx1234567890

Response:
{
  "message": "QR code deleted successfully"
}

GET

/analytics/:qrId

Get QR code analytics

GET /v1/analytics/clx1234567890

Response:
{
  "totalScans": 142,
  "uniqueVisitors": 98,
  "scansByCountry": [
    { "country": "United States", "count": 45 },
    { "country": "United Kingdom", "count": 23 }
  ],
  "scansByDate": [
    { "date": "2024-01-01", "count": 12 },
    { "date": "2024-01-02", "count": 18 }
  ]
}

Error Handling

Error Response Format

{
  "error": "Error message description",
  "code": "ERROR_CODE"
}

Common Error Codes

400Bad RequestInvalid parameters

401UnauthorizedInvalid or missing token

403ForbiddenPlan limit exceeded

404Not FoundResource doesn't exist

429Too Many RequestsRate limit exceeded

500Server ErrorInternal server error

Need Help?

Contact Support

Have questions about the API? Our team is here to help.

Manage API Tokens

Generate and manage your API tokens from the dashboard.