API
Availability: API access is available on every plan, including Free. Rate limits depend on your plan, and advanced link options and conversions need the plans that include them.
The Shortn REST API lives at https://app.shortn.link/api/v1. It uses API keys with scopes,
and answers in JSON. With it you can:
- create, read, update, suspend and re-enable links, and end A/B tests;
- read a link’s clicks;
- send leads, sales and refunds, and read conversion reporting;
- read workspaces, and manage their tags, UTM templates, teams and report destinations;
- manage report and alert rules;
- add, verify and remove custom domains.
Reference
- Authentication — API keys, data access, scopes, rate limits and errors.
- Links — create, list, get, update, suspend and re-enable links, and end A/B tests.
- Analytics — a link’s click totals.
- Conversions — send leads, sales and refunds, validate payloads, and read conversion reporting.
- Workspaces — the workspaces a key can reach.
- Tags — a workspace’s tags.
- UTM templates — a workspace’s UTM templates.
- Teams — a workspace’s teams.
- Destinations — where reports and alerts are delivered.
- Reports and alerts — report and alert rules.
- Domains — custom short domains.
- Public endpoints — anonymous links and their preview, URL validation, QR codes and the plan catalog, without a key.
Create keys in Profile → API keys. Keep them on the server; never put them in frontend code.
Last updated on