Skip to main content

​
API Overview

The Linquid API is a REST API that allows you to create, manage, and track links programmatically.

​
Base URL

https://api.linquid.io

​
Authentication

All API requests require authentication via Bearer token: 
curl https://api.linquid.io/links \
  -H "Authorization: Bearer lw_live_xxxx"
See Authentication for details on obtaining API keys.

​
Request Format

  • Use Content-Type: application/json for POST/PUT/PATCH requests
  • Send data as JSON in the request body
curl -X POST https://api.linquid.io/links \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"destinationUrl": "https://example.com"}'

​
Response Format

All responses are JSON with this structure:

​
Success

{
  "success": true,
  "data": {
    // Response data
  }
}

​
Error

{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable message"
  }
}

​
HTTP Status Codes

CodeDescription
200Success
201Created
400Bad Request - Invalid parameters
401Unauthorized - Invalid/missing API key
403Forbidden - Insufficient permissions
404Not Found
429Too Many Requests - Rate limited
500Internal Server Error

​
Pagination

List endpoints support pagination: 
curl "https://api.linquid.io/links?page=1&limit=20"
Response includes pagination metadata: 
{
  "success": true,
  "data": [...],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 150,
    "totalPages": 8
  }
}

​
Rate Limits

PlanLimit
Starter100/hour
Pro1,000/hour
Enterprise10,000/hour
Rate limit headers: 
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1704067200

​
Filtering

Many endpoints support filtering: 
# Filter by campaign
curl "https://api.linquid.io/links?campaignId=campaign_abc"

# Filter by date range
curl "https://api.linquid.io/analytics?from=2024-01-01&to=2024-01-31"

​
Endpoints

  • GET /links - List links
  • POST /links - Create link
  • GET /links/:id - Get link
  • PATCH /links/:id - Update link
  • DELETE /links/:id - Delete link

​
Rules

  • GET /rules - List rules
  • POST /rules - Create rule
  • PATCH /rules/:id - Update rule
  • DELETE /rules/:id - Delete rule

​
Analytics

  • GET /analytics - Get analytics overview
  • GET /analytics/:linkId - Get link analytics
  • GET /analytics/clicks - Get click data

​
Campaigns

  • GET /campaigns - List campaigns
  • POST /campaigns - Create campaign
  • GET /campaigns/:id - Get campaign
  • PATCH /campaigns/:id - Update campaign

​
Conversions

  • POST /conversions/s2s - Server-to-server conversion

​
QR Codes

  • POST /qr - Generate QR code
  • GET /qr/:linkId - List QR codes for link

​
Domains

  • GET /domains - List domains
  • POST /domains - Add domain
  • POST /domains/:id/verify - Verify domain
  • DELETE /domains/:id - Remove domain

​
SDKs

Official SDKs are coming soon. In the meantime, use the REST API directly or community libraries.

​
Support