Skip to main content

​
Base URL

All API requests should be made to: 
https://api.linquid.io

​
Authentication

Public API endpoints are authenticated via API key in the X-API-Key header. Dashboard/session endpoints use session authentication and CSRF protection. 
curl -H "X-API-Key: lw_your_api_key_here" \
  https://api.linquid.io/api/links
See Authentication for details.

​
Request Format

  • All request bodies must be JSON
  • Include Content-Type: application/json header for POST/PUT/PATCH requests

​
Response Format

All responses follow a consistent format:

​
Success Response

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

​
Success Response (List)

{
  "success": true,
  "data": [
    // Array of resources
  ],
  "pagination": {
    "total": 100,
    "page": 1,
    "limit": 20,
    "hasMore": true
  }
}

​
Error Response

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

​
HTTP Status Codes

CodeDescription
200Success
201Created
400Bad Request - Invalid input
401Unauthorized - Invalid or missing API key
403Forbidden - Insufficient permissions
404Not Found - Resource doesn’t exist
409Conflict - Resource already exists
429Too Many Requests - Rate limited
500Internal Server Error

​
Common Error Codes

CodeDescription
INVALID_API_KEYAPI key is invalid or disabled
UNAUTHORIZEDAuthentication required
FORBIDDENInsufficient permissions for this action
NOT_FOUNDRequested resource not found
VALIDATION_ERRORRequest body validation failed
RATE_LIMITEDToo many requests
INSUFFICIENT_CREDITSWorkspace has insufficient credits
FEATURE_NOT_AVAILABLEFeature not available on current plan

​
Pagination

List endpoints support pagination:
ParameterDescriptionDefault
pagePage number (1-indexed)1
limitItems per page20
curl "https://api.linquid.io/api/links?page=2&limit=50" \
  -H "X-API-Key: lw_your_api_key_here"

​
Filtering

Many list endpoints support filtering: 
# Filter links by campaign
curl "https://api.linquid.io/api/links?campaignId=camp_abc123" \
  -H "X-API-Key: lw_your_api_key_here"

# Filter by date range
curl "https://api.linquid.io/api/analytics/overview?start=2024-01-01&end=2024-01-31" \
  -H "X-API-Key: lw_your_api_key_here"

​
Timestamps

All timestamps are returned in ISO 8601 format (UTC): 
{
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T14:45:00.000Z"
}

​
IDs

Resources use prefixed IDs for easy identification:
PrefixResource
link_Links
rule_Rules
camp_Campaigns
px_Pixels
dom_Domains
ws_Workspaces

​
API Endpoints

Links

Create and manage smart links

Rules

Configure routing rules

Campaigns

Organize links into campaigns

Analytics

Access click and conversion data

Conversions

Track conversion events

Pixels

Manage tracking pixels

Advanced Modules

Workspace, billing, integrations, affiliate, partner, and security APIs

Workspaces

Manage workspaces, members, invitations, and ownership transfer

Billing

Plans, credits, subscriptions, and auto-recharge APIs

Customers & Events

Customer entities, event streams, cohorts, and attribution APIs

Integrations

Integration install/configuration, provider callbacks, and outbound webhooks

Affiliate & Partner

Program-owner APIs, marketplace flows, and partner-portal APIs

Webhooks

Workspace, link-level, and automation webhook management

Auth & Settings

Session auth lifecycle, linked accounts, and user settings APIs

Domains & Organization

Domain onboarding, tags, folders, and UTM template APIs

Tracking Modules

QR, deep-link attribution, publishable key, and SDK tracking APIs

Data Operations

Search, bulk operations, imports, and async export pipelines

Utilities & Support

FX rates, notifications, feedback, metatags, email logs, and wrapped APIs

Identity & Enterprise

OAuth apps, SAML SSO, and SCIM provisioning APIs

Public & Embed

Public stats and embedded analytics/link creation surfaces