REST API and automation

Developer tools for automated link management

Automate short-link creation, QR-code workflows, and aggregate analytics with TheShortener's authenticated REST API.

View API documentation Manage API keys

The API-key page is authenticated and may send guests to sign in. This public page never displays account credentials.

Create a managed link POST https://theshortener.com/api/url/add
  • Bearer API-key authentication
  • Custom alias and eligible domain options
  • Link and QR aggregate analytics

Custom aliases

Send the custom field to request a memorable alias. Custom aliases are subject to plan eligibility, a minimum length, availability, reserved-word rules, and safety checks.

"custom": "example-alias"

Custom domains

API-created links can request a domain that is available to the account. Domain access depends on plan entitlements and platform configuration.

Before publishing, verify domain ownership, DNS routing, and TLS. Adding a domain through the current API does not by itself prove those operational checks.

QR-code workflows

Eligible API keys can create, list, inspect, update, and delete QR codes for link and supported data types.

Build QR automation around verified endpoints

  • Create QR codes for links, text, vCard, phone, SMS, email, or Wi-Fi data.
  • Set supported foreground and background colors and an optional name.
  • Retrieve scan totals and aggregate analytics for link-based QR codes.

Analytics for automated workflows

Authenticated single-link and single-QR responses provide owner-scoped aggregate performance data.

Clicks and unique clicks

Read aggregate click totals for a managed link or link-based QR code.

Top locations and referrers

Review top countries and referrer domains returned by the API.

Browsers and operating systems

Use aggregate browser and operating-system breakdowns in reporting.

Social referrer counts

Read aggregate counts for supported social referrer categories.

The API does not promise realtime delivery, raw-event export, or a fixed analytics retention period on this page.

Integration use cases

Connect documented endpoints to the systems you already operate.

Publishing systems

Create a managed link when new content is published.

Internal dashboards

Display aggregate link or QR performance for authorized users.

Scheduled scripts

Create, inspect, or update individual links on a controlled schedule.

Campaign automation

Assign links to supported campaigns or channels and attach eligible pixels.

Offline campaigns

Generate QR codes that connect print, packaging, or event material to a link.

Safe quick start

Create one short link with the REST API

The documented create-link endpoint accepts a POST request with a bearer API key and a JSON body. Replace only the inert placeholders after managing a key in your authenticated dashboard.

Review all request fields and responses
cURL POST 
curl --request POST 'https://theshortener.com/api/url/add' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "https://example.com",
    "custom": "example-alias"
  }'

Current limitations

  • No maintained official SDK is included; use the documented REST endpoints directly.
  • No general public webhook-subscription API or batch short-link creation endpoint is documented.
  • API access and features depend on account plans, resource permissions, quotas, and platform configuration.
  • This page does not promise an exact rate limit, uptime level, SLA, realtime analytics, or fixed retention period.
  • Browser WebMCP discovery is not presented here as a standalone remote MCP server contract.

Developer tools FAQ

Planning automation for a growing campaign? Review the reliable link management guide.

Yes. TheShortener provides an authenticated REST API for supported link, QR-code, domain, campaign, channel, and pixel workflows.

Yes. Link creation accepts a custom alias when the account plan permits it and the alias is available, allowed, and at least three characters long.

Yes, when the domain is available to the account and the plan permits domain use. Domain ownership, DNS routing, and TLS should be verified before publishing links.

Yes. Eligible API keys can create, list, inspect, update, and delete QR codes. Link-based QR codes can also return aggregate scan analytics.

API keys are managed on the authenticated API Keys page. The public developer pages never display account credentials.

Start with the documented API contract

Review endpoints and request fields, then manage credentials from the authenticated dashboard when you are ready to build.

View API documentation Manage API keys