Linky
REST API v1

API Reference

Authenticate with an API key and call Linky's REST API v1. Available on the Business plan.

Get API accessFeature overview

14+

Endpoints

3

Webhook events

JSON

Request body

api_client.exe

POST /api/v1/links

POST/api/v1/links
Authorization: Bearer lk_••••••••201 Created

Request body

{
  "originalUrl": "https://shop.com/sale",
  "slug": "summer-sale",
  "title": "Summer promo"
}

Response

{
  "id": "lnk_8x2kq9m",
  "slug": "summer-sale",
  "shortUrl": "go.brand.io/summer-sale"
}

Same fields as the dashboard create form

01 // Authentication

Authentication

Create an API key in Dashboard → Settings. Send it on every request:

  • Header: Authorization: Bearer lk_your_api_key
  • Base URL: your Linky site + /api/v1
  • JSON request and response bodies unless noted

02 // Quick example

Create a link via curl

curl -X POST "https://your-site.com/api/v1/links" \
  -H "Authorization: Bearer lk_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"originalUrl":"https://example.com","slug":"launch"}'

Create keys in your dashboard under Settings (Business plan).

03 // Endpoints

Links

Core link CRUD and analytics endpoints.

GET/api/v1/linksList links
POST/api/v1/linksCreate link
GET/api/v1/links/{id}Get link
PATCH/api/v1/links/{id}Update link
DELETE/api/v1/links/{id}Delete link
POST/api/v1/links/bulkBulk create (CSV)
GET/api/v1/links/{id}/clicksAnalytics JSON/CSV
GET/api/v1/links/{id}/qrQR PNG or SVG
GET/api/v1/links/{id}/rulesList rules
POST/api/v1/links/{id}/rulesAdd rule
GET/api/v1/domainsList domains
POST/api/v1/domainsAdd domain
GET/api/v1/webhooksList webhooks
POST/api/v1/webhooksRegister webhook

04 // Domains & keys

Domains & webhooks

Manage custom domains and outbound webhooks programmatically.

  • GET/POST /api/v1/domains — list and add domains
  • GET/POST/DELETE /api/v1/webhooks — manage webhooks
  • GET/POST/DELETE /api/v1/api-keys — manage API keys

05 // Webhooks

Webhooks payload

Outbound POST requests include event type, timestamp, and link data. Verify signatures using the secret shown when you create the webhook.

link.created

New short link saved

link.updated

Destination or metadata changed

link.clicked

Visitor clicked — includes geo/device

  • ·Events: link.created, link.updated, link.clicked
  • ·HTTPS endpoints only
  • ·Retry on 5xx responses

06 // FAQ

API questions

What happens if my plan downgrades from Business?

Existing API keys stop authenticating. Webhooks are not delivered. Upgrade again to restore access.

Business plan required

Automate your link stack.

Upgrade to Business for API keys, webhooks, and audit log access.

Upgrade to Business← Getting started guide