API (REST)

The Cuttly API turns link management from a manual dashboard activity into a programmable capability — available from the free plan, no paid subscription required to start.

---

Definition

A REST API (Representational State Transfer Application Programming Interface) is a programmatic interface that allows software applications to interact with a service over HTTP. Cuttly's REST API allows applications and automation systems to create, manage and retrieve analytics for short links without using the web dashboard.

Two API Tiers: Regular API and Team API

Cuttly provides two distinct API tiers with different scopes and plan requirements:

Each team has its own dedicated Team API key, separate from the owner's personal Regular API key. Team members with Owner or Admin roles can generate the team API key from within the team dashboard.

API Documentation

Full API documentation — including all available endpoints, request parameters, response formats, authentication details and code examples — is available at:

• Cuttly API Overview — cutt.ly/cuttly-api
• Regular API Documentation
• Team API Documentation

Authentication

API authentication uses an API key — generated from the Cuttly account settings. The key is passed as a parameter with each API call. Keys should be treated as secrets: stored in environment variables or secrets management systems, never hardcoded in source code or committed to version control.

The Regular API key is generated from the personal account settings. The Team API key is generated from within the team dashboard by a team Owner or Admin.

Rate Limits

API rate limits in Cuttly are measured per account, per 60 seconds:

Upgrading a plan increases the rate limit without requiring any changes to your API code. See also: API Rate Limits.

Common Integration Patterns

• Per-user onboarding links. Application creates a unique branded short link per new user signup and includes it in the welcome email.
• Dynamic documentation links. CMS publishes content; automation creates a short link and stores it with the content record.
• Referral programme links. Application generates a unique short referral link per user; analytics endpoint tracks performance per referrer.
• CI/CD deployment links. Deployment pipeline creates a short link to the deployed environment URL and posts it to the team's communication channel.
• Custom analytics dashboards. Scheduled job queries the analytics endpoint and writes data to a data warehouse or BI tool.

Getting Started

1. Create a free account at cutt.ly/register
2. Navigate to account settings to generate your API key
3. Review the API documentation at cutt.ly/cuttly-api
4. Start with the Regular API — free plan, 3 req/60s, no code changes needed when upgrading

Related Terms

• API Rate Limits
• Integrations: Zapier / Make
• Teams & Roles
• CSV Bulk Import