API Reference

URL Shortener API

Create short links that route through your checkpoint flow before reaching the destination.

Full request & response examples in your dashboard

You're viewing the public API reference. Sign in and open Documentation → API Reference in your dashboard for copy-paste curl requests and live response examples for every endpoint.

Create a short link

POST /api/v1/public/shortener/create

Authenticate with the x-api-key header (or an api_key field in the body). Requires the allowUrlShortener permission.

Notes

The checkpoint field routes the link through 1–10 checkpoints.
Links can be temporary, self-destructing after 30 minutes or after the checkpoint is completed.