Documentation

Everything you need to get started with LinkSnap — from CLI setup to API integration.

Quick Start

Get up and running in under a minute.

terminal

# Install the CLI
npm install -g @forjio/linksnap-cli

# Authenticate
linksnap auth login

# Create your first link
linksnap links create https://example.com --slug my-link

# Check analytics
linksnap stats my-link

Guides

CLI Quick Start

Install the CLI, authenticate, and create your first short link in under a minute.

API Reference

Full REST API documentation with request/response examples for every endpoint.

Analytics

Understand your click data — geo, device, referrer, time-series breakdowns.

Link Management

Tags, search, bulk operations, and organizing links at scale.

Import & Export

Migrate from Bitly or other services. Export everything as CSV or JSON.

QR Codes

Create customizable QR codes, track scans, and download in PNG or SVG.

Custom Domains

Connect your own domain for fully branded short links with free SSL.

API Overview

All endpoints are available at https://linksnap.forjio.com/api. Authenticate with a Bearer token (JWT) or API key.

Method	Endpoint	Description
POST	/api/links	Create short link
GET	/api/links	List links (paginated)
GET	/api/links/:id/stats	Get analytics
PATCH	/api/links/:id	Update link
DELETE	/api/links/:id	Delete link
POST	/api/qr-codes	Create QR code
GET	/api/qr-codes	List QR codes
GET	/api/qr-codes/:id/stats	QR scan analytics