Omni Links REST API

Authentication

curl https://your-domain.com/api/v1/links \
  -H "Authorization: Bearer $OMNI_LINKS_API_KEY"

Create a link

curl https://your-domain.com/api/v1/links \
  -H "Authorization: Bearer $OMNI_LINKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "destinationUrl": "https://example.com/landing",
    "slug": "launch",
    "title": "Launch campaign",
    "password": "at-least-8-characters",
    "tags": ["launch", "paid"],
    "utmParameters": {
      "utm_source": "newsletter",
      "utm_medium": "email"
    }
  }'

Passwords are write-only and must be 8–128 characters. Link responses expose only passwordProtected; password hashes are never returned or included in workspace exports. If you provide a slug, it must contain at least two URL-safe characters. Omit the field to generate one automatically.

Bulk create links

curl https://your-domain.com/api/v1/links/bulk \
  -H "Authorization: Bearer $OMNI_LINKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "links": [
      {
        "destinationUrl": "https://example.com/launch",
        "slug": "launch",
        "title": "Launch campaign"
      }
    ]
  }'

Create a webhook

curl https://your-domain.com/api/v1/webhook-endpoints \
  -H "Authorization: Bearer $OMNI_LINKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/webhooks/omni-links",
    "events": ["link.created", "link.clicked"]
  }'

Export analytics

curl "https://your-domain.com/api/v1/exports/analytics?format=csv&days=30" \
  -H "Authorization: Bearer $OMNI_LINKS_API_KEY"

Create a scheduled report

curl https://your-domain.com/api/v1/reports/analytics \
  -H "Authorization: Bearer $OMNI_LINKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Weekly growth report",
    "frequency": "weekly",
    "format": "csv",
    "rangeDays": 30,
    "recipients": ["growth@example.com"],
    "webhookUrl": "https://example.com/omni-reports"
  }'

Create a route rule

curl https://your-domain.com/api/v1/links/link_uuid/route-rules \
  -H "Authorization: Bearer $OMNI_LINKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "country",
    "operator": "equals",
    "matchValue": "DE",
    "destinationUrl": "https://example.com/de",
    "priority": 10
  }'

Create a QR code

curl https://your-domain.com/api/v1/qr-codes \
  -H "Authorization: Bearer $OMNI_LINKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "linkId": "link_uuid",
    "name": "Launch poster",
    "customization": {
      "foregroundColor": "#111827",
      "backgroundColor": "#ffffff",
      "errorCorrectionLevel": "H",
      "margin": 3,
      "patternStyle": "rounded"
    }
  }'