REST API
Build on your links.

Identity, workspace, plan and every entitlement that plan carries. The cheapest way to verify a token and to discover what the account is allowed to do before you attempt it.

curl -H "X-API-KEY: YOUR_TOKEN" \
  https://letl.ink/api/v1/me

{
  "data": {
    "user": { "id": 1, "email": "[email protected]", "name": "You" },
    "workspace": { "id": 12, "name": "My Workspace", "block_bots": true },
    "plan": {
      "id": "growth",
      "name": "Growth",
      "limits": {
        "links": 200,
        "monthly_clicks": 100000,
        "custom_domains": 3,
        "qr_codes": 30,
        "retention_days": 365
      },
      "features": {
        "api": true,
        "webhooks": true,
        "integrations": true,
        "ai_access": false,
        "geo_analytics": false,
        "smart_link_types": true
      }
    },
    "base_domain": "letl.ink"
  }
}

How much of each allowance is consumed this billing month. Use it to warn a customer before they hit the tracked-click ceiling — past it the redirect still works, but clicks stop being recorded.

{
  "data": {
    "links": { "used": 42, "limit": 200, "remaining": 158, "percent_used": 21.0 },
    "clicks_this_month": { "used": 8140, "limit": 100000, "remaining": 91860, "percent_used": 8.1 },
    "custom_domains": { "used": 1, "limit": 3, "remaining": 2, "percent_used": 33.3 },
    "qr_codes": { "used": 4, "limit": 30, "remaining": 26, "percent_used": 13.3 }
  },
  "meta": { "plan": "growth", "period": "2026-09" }
}

Custom domains on the workspace and whether each one has finished DNS verification. Only verified domains may be used as the domain field when creating a link.

Every integration the product offers, whether your plan includes it, whether this workspace has connected it, and how delivery is going — last status, last error and consecutive failure count. Useful for monitoring a fleet of workspaces.

Links in the workspace, with click totals split into all, ios, android and desktop. Links with zero clicks are included.

Query parameters

• domain string

  Restrict to one hostname. Omit to list every hostname in the workspace.

  Optional
• search string

  Matches short code, title and destination.

  Optional
• type string

  direct, utm, appstore, instagram, mobile or device.

  Optional
• archived boolean

  Defaults to false. Pass true to list the archive instead.

  Optional
• favorite boolean

  Restrict to starred links.

  Optional
• sort string

  created_at (default), clicks, short_code, title or updated_at.

  Optional
• direction string

  asc or desc. Defaults to desc.

  Optional
• limit integer

  1–200. Defaults to 50.

  Optional
• offset integer

  Defaults to 0.

  Optional
• start_date date

  YYYY-MM-DD. Windows the click totals, not which links are returned.

  Optional
• end_date date

  YYYY-MM-DD, inclusive.

  Optional

curl -H "X-API-KEY: YOUR_TOKEN" \
  "https://letl.ink/api/v1/links?sort=clicks&limit=20"

{
  "data": [
    {
      "id": 49,
      "short_code": "spring",
      "domain": "letl.ink",
      "url": "https://letl.ink/spring",
      "destination": "https://shop.example.com/spring",
      "title": "Spring sale",
      "type": "utm",
      "archived": false,
      "favorite": true,
      "created_at": "2026-08-01T09:14:00+00:00",
      "updated_at": "2026-09-02T11:00:00+00:00",
      "clicks": { "all": 650, "ios": 180, "android": 210, "desktop": 260 },
      "total_clicks": 650,
      "device_limit": null,
      "utm": { "source": "twitter", "medium": "social", "campaign": "spring" },
      "split_test": {
        "variations": [
          { "name": "control", "url": "https://example.com/a", "weight": 2 },
          { "name": "variant-b", "url": "https://example.com/b", "weight": 1 }
        ]
      }
    }
  ],
  "meta": {
    "total": 42, "limit": 20, "offset": 0,
    "has_more": true, "next_offset": 20,
    "sort": "clicks", "direction": "desc",
    "date_range": { "start_date": null, "end_date": null },
    "domain": "all"
  }
}

One link by id, in the same shape the list endpoint returns.

Create a short link. Omit short_code for a random one. If the destination has no title we fetch the page title in the background.

JSON body

• destination

  The URL to redirect to. Required for direct and utm links. original_url is accepted as an alias.

  Required*
• short_code

  Up to 20 characters: letters, numbers, hyphens and underscores, not starting or ending with a separator. Must be unique per hostname.

  Optional
• title

  Display name in the dashboard.

  Optional
• domain

  A verified custom domain, or the base domain. Defaults to the base domain.

  Optional
• type

  direct (default), utm, appstore, instagram, mobile or device. Everything but direct and utm needs the Solo, Growth or Ultimate plan.

  Optional
• utm_source, utm_medium, utm_campaign

  For utm links; utm_source is required when type is utm.

  Optional
• ios_url, android_url

  Platform destinations for appstore and mobile links.

  Optional
• desktop_url, mobile_url

  Both required for device links.

  Optional
• instagram_username

  For instagram links.

  Optional
• split_variations

  An array of {name, url, weight} objects — at least two — to run a weighted split test on a direct or utm link.

  Optional
• limit_visits_per_device

  Set true and supply visit_limit_per_device to cap hourly visits per device.

  Optional

curl -X POST https://letl.ink/api/v1/links \
  -H "X-API-KEY: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
        "destination": "https://shop.example.com/spring",
        "short_code": "spring",
        "title": "Spring sale",
        "type": "utm",
        "utm_source": "twitter",
        "utm_campaign": "spring"
      }'

The created link, in the shape shown above.

Create many links in one request. Each row is attempted independently: valid rows are created and the failures are reported per index, so one bad URL never discards the rest of the batch. Returns 201 when anything was created, 422 when nothing was.

curl -X POST https://letl.ink/api/v1/links/bulk \
  -H "X-API-KEY: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"links":[
        {"destination":"https://example.com/1","short_code":"one"},
        {"destination":"https://example.com/2"}
      ]}'

{
  "data": [ { "id": 51, "short_code": "one", … } ],
  "meta": {
    "requested": 2,
    "created": 1,
    "failed": 1,
    "errors": [
      { "index": 1,
        "code": "invalid_request",
        "message": "This shortcode is already taken.",
        "short_code": "two" }
    ]
  }
}

PATCH merges: only the fields you send are changed, everything else keeps its current value. PUT replaces: anything you omit is cleared. Accepts the same fields as create.

curl -X PATCH https://letl.ink/api/v1/links/49 \
  -H "X-API-KEY: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"title": "Spring sale — extended"}'

Archives the link: it stops resolving and frees an allowance slot, while its click history is kept. There is deliberately no permanent delete on the API — destroying a link and its history stays a dashboard action behind an explicit confirmation.

Brings an archived link back into rotation. Returns 403 plan_required if the workspace is already at its active-link allowance.

Individual visits to one link, newest first. Accepts limit and offset. Country is included on every plan.

The headline numbers for the whole workspace: clicks all-time and in the window, unique visitors, QR scans, peak day, and hour-of-day and day-of-week distributions. Accepts days (default 30, clamped to your retention).

{
  "data": {
    "window_days": 30,
    "clicks": {
      "total": 24592, "window": 8140, "last_7_days": 2103,
      "daily_average": 271,
      "peak_day": { "date": "Sep 02", "clicks": 612 }
    },
    "visitors": { "unique_total": 18204, "unique_window": 6021 },
    "qr": { "scans_total": 940, "scans_window": 310 },
    "timing": {
      "by_hour": [12, 4, 2, …],
      "by_weekday": [1420, 1610, 1585, 1490, 1310, 480, 245],
      "peak_hour": { "peakHour": 14, "peakValue": 812, "label": "14:00–14:59" },
      "peak_weekday": { "peakDay": 1, "peakValue": 1610, "label": "Tuesday" }
    },
    "links": { "active": 42, "limit": 200 }
  },
  "meta": { "plan": "growth", "geo_included": true, "retention_days": 365 }
}

Daily click counts, ready to chart. Pass link_id to scope it to one link, and days to set the window. Days with no traffic are returned as zero rather than omitted, so the series is always contiguous.

{
  "data": [
    { "date": "Sep 04", "clicks": 22 },
    { "date": "Sep 05", "clicks": 11 }
  ],
  "meta": { "window_days": 7, "total": 33, "link_id": null }
}

Clicks grouped by one dimension, with each row's share of the total.

Query parameters

• dimension string

  channel, referrer, device, browser, os, brand, variation or country. browser, os, brand and variation need a link_id.

  Required
• link_id integer

  Scope to one link. Omit for the whole workspace.

  Optional
• limit integer

  1–100. Defaults to 10.

  Optional

{
  "data": [
    { "label": "Search", "value": 215, "share": 33.1 },
    { "label": "Social", "value": 201, "share": 30.9 },
    { "label": "Direct / none", "value": 142, "share": 21.8 }
  ],
  "meta": { "dimension": "channel", "link_id": 49, "total": 650 }
}

Everything the dashboard shows for one link in a single call: the link itself, click totals, unique and returning visitors, the daily series, hour and weekday distributions, all breakdowns, and the split-test scoreboard when the link is running one.

"split_test": {
  "active": true,
  "conclusive": true,
  "minClicks": 100,
  "leader": "control",
  "totalClicks": 650,
  "totalVisitors": 172,
  "arms": [
    { "name": "control", "isControl": true, "weight": 2,
      "clicks": 357, "visitors": 60,
      "expectedShare": 50.0, "actualShare": 54.9, "drift": 4.9 },
    { "name": "variant-b", "isControl": false, "weight": 1,
      "clicks": 146, "visitors": 57,
      "expectedShare": 25.0, "actualShare": 22.5, "drift": -2.5 }
  ]
}

The raw visit feed across every link in the workspace, newest first. This is the modern replacement for GET /visits: same data, standard envelope, limit and offset support.

{
  "data": [
    {
      "id": 2691,
      "link_id": 49,
      "short_code": "spring",
      "occurred_at": "2026-09-10T22:45:33+00:00",
      "ip_address": "203.0.113.7",
      "referrer": "https://twitter.com/",
      "browser": "Chrome",
      "os": "iOS",
      "device_type": "mobile",
      "device_brand": "Apple",
      "country": "US",
      "variation": "control"
    }
  ],
  "meta": { "limit": 50, "returned": 50, "geo_included": true }
}

Webhook endpoints registered on this account.

Register an HTTPS endpoint to receive a JSON payload on every recorded click. Up to 25 per account. Failed deliveries are retried automatically.

JSON body

• target_url

  Must be https://.

  Required
• event

  Defaults to link_visited, which is currently the only event.

  Optional

curl -X POST https://letl.ink/api/v1/hooks \
  -H "X-API-KEY: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"target_url": "https://example.com/hooks/clicks"}'

Remove a webhook endpoint. POST /hooks/subscribe and DELETE /hooks/unsubscribe/{id} remain available for Zapier's REST Hook flow.

The original connection test: returns your user id, email and workspace id/name as a flat object. GET /me returns the same identity plus your plan limits and feature flags, and is the better choice for new code.

curl -H "X-API-KEY: YOUR_TOKEN" \
  https://letl.ink/api/v1/auth/me

{
  "id": 1,
  "email": "[email protected]",
  "workspace_id": 12,
  "workspace_name": "My Workspace"
}

Click totals for a single link, addressed by domain and slug rather than by id. Both parameters are required. GET /links/{id} and GET /analytics/links/{id} cover the same ground when you know the id.

Query parameters

• domain string

  The base domain or one of your verified custom domains.

  Required
• slug string

  The short code, without a leading slash.

  Required
• start_date date

  YYYY-MM-DD, clamped to your plan's retention.

  Optional
• end_date date

  YYYY-MM-DD, inclusive.

  Optional

The 50 most recent visits across the workspace as a bare JSON array — no envelope — using visit_id, visit_time, link_shortcode and visitor_* field names. This is what Zapier's REST Hook "perform list" step reads, so its shape is frozen. Use GET /events for new work.

The 50 most recent visits to one link, as a bare array with created_at, ip_address, country, device_type, browser, os and referrer. Frozen alongside /visits; use GET /links/{id}/events for new work.

REST Hook subscribe. Takes target_url and an optional event (default link_visited) and returns the created subscription flat, without an envelope. POST /hooks is the same operation in the standard shape.

REST Hook unsubscribe, returning {"success": true}. DELETE /hooks/{id} is the equivalent in the standard shape.