Is the API available on all plans?
Yes! All plans from Free to Business have API access. Rate limits vary by plan: Free (100 req/min), Starter (300 req/min), Growth (600 req/min), Pro (1,200 req/min), Business (3,000 req/min).
Can I create multiple API keys?
Yes, you can create multiple API keys for different applications or environments (development, staging, production). This allows you to revoke keys independently if one is compromised.
Do API-created links count towards my plan limit?
Yes. All links created via the API count towards your plan's total link limit (Free: 10, Starter: 300, Growth: 1,000, Pro: 5,000, Business: 25,000). You'll receive a 403 error if you attempt to exceed your limit.
Can I use the API to update link analytics?
No. Click analytics are automatically collected when users click your links. The API provides read-only access to analytics data via GET /api/v1/clicks.
Is there a webhook system for real-time events?
Not yet. Webhooks for click events, link creation, and other real-time notifications are planned for a future release. Currently, you need to poll the API to check for new clicks.
How do I test the API without affecting my production data?
Create a separate API key for testing and use it with test links. You can also use a different campaign or folder to organize test links separately from production links. There's no sandbox environment currently.
Can I bulk create links via the API?
Yes, but you need to make multiple POST /api/v1/links requests (one per link). Be mindful of rate limits. Use a delay between requests or implement batch processing with retries. For large bulk uploads (100+ links), consider using the CSV bulk upload feature in the dashboard instead.
What happens if I delete a link via the API?
Deleting a link via DELETE /api/v1/links/:slug permanently removes the link and all its associated click analytics data. This action cannot be undone, so use with caution.
Are there official API client libraries or SDKs?
Not officially at this time. However, the API follows REST conventions and works with any HTTP client library (fetch, axios, requests, curl, etc.). Community-contributed SDKs may be available. Check our GitHub or documentation updates.
Can I use the API to manage team members or billing?
No. The current API focuses on link management and analytics. Team member management, billing, and account settings are only available through the web dashboard.
What's the API version policy?
The current API is version 1 (/api/v1). We'll maintain backward compatibility and provide advance notice before deprecating endpoints. New features may be added without version changes if they don't break existing integrations.
How do I report API bugs or request features?
Email us at [email protected] with details about the bug or feature request. Include your API request/response examples, error messages, and expected behavior.