Learn how to use Linkkit’s REST API to manage links, QR codes, analytics, webhooks, and more.

Authenticate with lk_ API keys, call https://api.uselinkkit.com/v1, paginate with page/limit, and manage Linkkit links, analytics, conversions, and webhooks.

API Introduction | Linkkit

Introduction

Learn how to use Linkkit’s REST API to manage links, QR codes, analytics, conversions, webhooks, and more.

Learn how to use the Linkkit API to create, manage, and track short links programmatically. Explore authentication, SDKs, API requests, error handling, pagination, and integration guides.

Linkkit API Documentation | Manage Short Links, Analytics & Integrations

Authenticate to the Linkkit API with secret lk_ keys, publishable pk_live_ keys, and related auth paths.

Use Linkkit secret API keys (lk_) with Bearer or X-Api-Key, configure permissions and scopes, and use publishable keys for /track conversion endpoints.

API Authentication | Linkkit

API Authentication

Authenticate to the Linkkit API with secret lk_ keys and publishable pk_live_ keys. Manage permissions, scopes, and conversion tracking credentials.

Authenticate Linkkit API requests with Bearer or X-Api-Key (lk_), configure permissions and scopes, and use publishable keys for /track endpoints.

Authentication

Bearer token. Pass your workspace API key as `Bearer <YOUR_API_KEY>`.

Authorization

original_url

title

Optional custom domain hostname for the short link.

custom_domain

expire_at

notes

list_id

Create a short link for the authenticated workspace.

Example campaign

{
  "error": "original_url is required"
}

{
  "error": "URL failed safety checks"
}

Create a link | Linkkit API

Create a link

New destination URL (re-screened for safety).

is_active

Rename the short code. Must be unique, ≥ 3 chars, letters/numbers/hyphens/underscores.

short_code

Partial update — only include fields you want to change.

The short code of the link (e.g. `abc123`).

shortCode

Updated title

{
  "error": "short_code already taken"
}

{
  "error": "short_code must be at least 3 characters"
}

Update a link | Linkkit API

Update a link

Active flag (defaults to true on create).

Create a link with the given short code if it does not exist, or update it if it does.

Upsert a link | Linkkit API

Upsert a link

Permanently delete a short link by short code.

{
  "error": "Forbidden. Insufficient permissions for links."
}

Delete a link | Linkkit API

Delete a link

Retrieve a link | Linkkit API

Retrieve a link

Returns a paginated list of short links, ordered by creation date descending.

page

limit

Filter by URL or title (case-insensitive substring).

search

Filter by active status (`true` or `false`).

List links | Linkkit API

List links

Array of link objects (max 1000). Each item requires `original_url`; optional `title`, `notes`, `custom_domain`.

links

Create up to 1,000 short links in a single request.

{
  "created": 2,
  "skipped": 0,
  "errors": []
}

{
  "error": "links array is required and must not be empty"
}

Bulk create links | Linkkit API

Bulk create links

Create a new short link in the authenticated workspace.

Links

Understand Linkkit request throttling (429), plan link quotas (403), bulk caps, and how to design reliable API clients.

Handle Linkkit API 429 backoff and 403 plan link quotas. Use bulk create, webhooks, pagination, and caching — without invented RPM header myths.

Rate limits | Linkkit

Rate limits

Understand Linkkit request throttling, plan link quotas, bulk caps, and client best practices.

Handle Linkkit API 429 backoff and 403 plan quotas. Use bulk create, webhooks, and pagination — without invented RPM tables.

Rate Limits

Install and use the official Linkkit TypeScript SDK (@getlinkkit/linkkit) to call the API with full type safety.

Install @getlinkkit/linkkit, authenticate with your API key, and manage links, QR codes, analytics, and more from TypeScript.

TypeScript SDK | Linkkit

Learn how to install and use the Linkkit Analytics SDK for client-side conversion tracking, click tracking, cross-domain tracking, reverse proxy support, and customizable tracking options.

Linkkit Analytics SDK – Client-Side Conversion Tracking & Installation Guide

TypeScript SDK

Use the Linkkit MCP server to manage your workspace with the AI agent of your choice.

Linkkit MCP Server | Linkkit

Linkkit MCP Server

Learn how to connect the Linkkit MCP Server with AI assistants like Claude, Cursor, GitHub Copilot, Gemini CLI, and other MCP-compatible clients. Securely manage links, QR codes, analytics, and workspace resources using natural language and the Linkkit API.

Linkkit MCP Server | Connect AI Assistants to Your Link Management Workspace

MCP Server

Returns all custom domains attached to the workspace, ordered by creation date descending.

{
  "error": "Forbidden. Insufficient permissions for domains."
}

List domains | Linkkit API

List domains

Returns a single domain including DNS verification records.

Retrieve a domain | Linkkit API

Retrieve a domain

List and inspect custom domains attached to your workspace.

Domains | Linkkit API

Domains

name

color

Create a list for organizing links in your workspace.

Product Hunt Links

Create a list | Linkkit API

Create a list

Launch links

{
  "error": "No valid fields to update"
}

Update a list | Linkkit API

Update a list

Delete a list | Linkkit API

Delete a list

{
  "error": "Forbidden. Insufficient permissions for lists."
}

List lists | Linkkit API

List lists

Retrieve a list | Linkkit API

Retrieve a list

Group links into named lists (Linkkit’s equivalent of folders).

Lists | Linkkit API

Lists

marketing

Create a tag | Linkkit API

Create a tag

{
  "error": "Forbidden. Insufficient permissions for tags."
}

List tags | Linkkit API

List tags

growth

Update a tag | Linkkit API

Update a tag

Retrieve a tag | Linkkit API

Retrieve a tag

Delete a tag | Linkkit API

Delete a tag

Organise links with coloured tags (segments).

Linkkit API Reference

Categories

Linkkit api

Linkkit links api

Sdks

Popular Articles