A URL shortener API with the same rules as the dashboard

A programmatic url shortener api is only useful if it doesn't quietly behave differently from the product you tested by hand. On lnkz.xyz the API runs through the same validation and plan gates as the dashboard - if a custom alias requires Pro in the UI, it requires Pro through the API too, with no special case for where the request came from.

Getting a key

Create a key from /app/keys once your email is verified - signing in with Google counts as verified automatically. The key is prefixed lnkz_ and shown exactly once, the same handling as a webhook signing secret: write it down immediately, because it won't be displayed again.

What the API covers

• Create a link with the same options as the dashboard form - custom alias, tags, expiration, password, and UTM parameters, all still gated by plan.
• List your links with cursor pagination, up to 100 per page.
• Fetch, update, or soft-delete a single link by its code - deleted codes are never reused, same as the dashboard.
• Download a QR code as PNG or SVG, on Pro and Business.

Limits

Daily requests are capped by plan - 100 on Free, 10,000 on Pro, 100,000 on Business, resetting at UTC midnight. Monthly link-create quotas are the same ones the dashboard enforces; the API doesn't get a separate allowance on top of them.

Errors you can actually branch on

Every error comes back with a stable string code - unauthorized, invalid_url, alias_taken, reserved, gated, quota_exceeded, rate_limited - not just an HTTP status, so your code can handle each case without parsing a human-readable message.

Read the full API reference