Skip to main content

API Authentication

Linquid uses API keys for authentication.

Getting an API Key

  1. Log in to dashboard.linquid.io
  2. Navigate to Settings > API Keys
  3. Click Create API Key
  4. Name your key and select scopes
  5. Copy the key (shown only once)

Using Your Key

Include in the Authorization header:
curl https://api.linquid.io/links \
  -H "Authorization: Bearer lw_live_your_api_key_here"

Scopes

Limit API key permissions:
ScopeAccess
links:readRead links
links:writeCreate/update/delete links
rules:readRead rules
rules:writeCreate/update/delete rules
analytics:readView analytics
campaigns:readRead campaigns
campaigns:writeManage campaigns
domains:readRead domains
domains:writeManage domains

Error Responses

Missing Key

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "API key is required"
  }
}

Invalid Key

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid API key"
  }
}

Insufficient Scope

{
  "success": false,
  "error": {
    "code": "FORBIDDEN",
    "message": "API key does not have 'links:write' scope"
  }
}

Best Practices

Never expose API keys in client-side code, public repositories, or logs.
  • Store keys in environment variables
  • Use minimum required scopes
  • Rotate keys periodically
  • Monitor usage for anomalies