API Quick Start

Integrate Linkify's RESTful API into your application in under 5 minutes. Our endpoints are designed for high throughput, offering sub-200ms latency for link generation and real-time clickstream data retrieval for enterprise-grade tracking.

Integration Steps

3 Steps to your first API integration

1. Generate API Credentials

Navigate to the Developer Console in your dashboard settings. Generate a new Secret Key and enable the 'Write Links' scope. Store this securely in your environment variables.

2. Send Your First Request

Use the standard `POST /v1/links` endpoint. Pass your `Authorization: Bearer` header and include the target URL in the JSON payload. We support standard HTTPS and custom redirect codes.

3. Parse the JSON Response

Upon success, the API returns a 201 status code with your new shortened URL, the unique `link_id`, and an embedded tracking pixel source for immediate event listening.

Technical Reference

cURL Request & JSON Response

cURL Command

curl -X POST https://api.linkify.com/v1/links \
  -H "Authorization: Bearer sk_live_8d9s7f6a5b4c3d2e" \
  -H "Content-Type: application/json" \
  -d '{
    "target": "https://example.com/product-launch-v2",
    "domain": "lnk.fy",
    "tags": ["marketing", "q4-campaign"]
  }'

JSON Response (201 Created)

{
  "status": "success",
  "data": {
    "id": "lnk_882910x",
    "short_url": "https://lnk.fy/882910x",
    "target_url": "https://example.com/product-launch-v2",
    "created_at": "2023-10-24T14:30:00Z",
    "analytics": {
      "total_clicks": 0,
      "unique_visitors": 0
    }
  }
}

Ready to scale your link management? Our SDKs for Python, Node.js, and Go are available on GitHub.

Download SDKs