URLUSH API Documentation

Everything you need to integrate URL shortening into your applications.

Getting Started

Quick start guide and authentication

API Endpoints

Complete reference for all API endpoints

Webhooks

Event notifications and integration

SDKs & Libraries

Client libraries for popular languages

API Overview

The URLUSH API allows you to programmatically create and manage short links, retrieve analytics data, and integrate URL shortening functionality into your applications.

Base URL

https://api.urlush.com/v1

Authentication

All API requests require authentication using an API key. You can obtain an API key from your URLUSH dashboard.

Authorization: Bearer YOUR_API_KEY

Rate Limits

Rate limits vary based on your plan. The API returns standard rate limit headers to help you manage your usage.

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1620000000

Example: Creating a Short Link

// Request
POST /v1/links
{
  "destination": "https://example.com/very/long/url/that/needs/shortening",
  "title": "My Example Link",
  "tags": ["example", "documentation"]
}

// Response
{
  "id": "abc123",
  "shortUrl": "https://urlsh.io/abc123",
  "destination": "https://example.com/very/long/url/that/needs/shortening",
  "title": "My Example Link",
  "tags": ["example", "documentation"],
  "createdAt": "2023-05-01T12:00:00Z",
  "clicks": 0
}