API Reference

The LinkShark API allows you to programmatically create, update, and manage shortened URLs for your organization. All API endpoints are authenticated via an API key and follow a consistent JSON response envelope.

Base URL

All API requests are made to the following base URL:


https://api.linkshark.xyz/link/external/v1

Response Envelope

Every API response is wrapped in a standard LinkSharkResponse envelope:


{
  "response": { ... },
  "errors": null
}

response — Contains the result payload on success. null when the request fails.
errors — null on success. On failure, contains an array of error objects:


{
  "response": null,
  "errors": [
    {
      "code": "VE001",
      "message": "Invalid short code format. Must be 3-50 characters, alphanumeric, underscore or hyphen only."
    }
  ]
}

Sections

Explore each section for detailed documentation:

Authentication — How API key authentication works
Obtaining Your API Key — Step-by-step guide to generate and manage your API key from the dashboard
Quick Start — End-to-end example to create your first short link
Endpoints — Create, update, bulk save, and list shortened URLs
Rate Limiting — Request limits and best practices
API Errors — Error codes, HTTP status codes, and detailed error scenarios
Field Reference — Complete request/response field reference