Skip to main content

API Now Live!

REST API v1 is production-ready. Start building today.

Get API Key
API v1 - PRODUCTION READY

Build with Mobily API

Powerful URL shortener REST API to create, manage, and track short links programmatically

Fast & Simple

RESTful API with JSON responses. Get started in minutes with our simple authentication.

Secure

API key authentication with rate limiting. HTTPS-only endpoints for maximum security.

Analytics

Full analytics data for every link. Track clicks, referrers, devices, and more.

Quick Start

1 Get Your API Key

Generate your API key from your dashboard. Rate limits by plan: Starter 5,000/hr · Pro & Business 10,000/hr. API access requires a paid plan.

Go to API Keys

2 Make Your First Request

Create a short link with a simple POST request:

curl -X POST https://mobily.ca/api/v1/links \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/very-long-url",
    "short_code": "mylink"
  }'

3 Get Response

Receive your shortened link instantly:

{
  "data": {
    "id": 123,
    "short_code": "mylink",
    "short_url": "https://mobily.ca/mylink",
    "original_url": "https://example.com/very-long-url",
    "title": null,
    "total_clicks": 0,
    "created_at": "2026-03-02T14:30:00Z"
  }
}

API Endpoints

POST /api/v1/links

Create Short Link

Create a new shortened URL with optional custom alias and settings.

Parameters:

  • url (required) - The original URL to shorten
  • short_code (optional) - Custom short code
  • title (optional) - Label for the link
  • password (optional) - Password to protect the link
  • expires_at (optional) - Expiration date (YYYY-MM-DD)
  • max_clicks (optional) - Maximum click limit
GET /api/v1/links/{id}

Get Link Details

Retrieve information about a specific shortened link including analytics.

GET /api/v1/links

List All Links

Get a paginated list of all your shortened links.

PUT /api/v1/links/{id}

Update Link

Update link settings like password, expiration, or destination URL.

DELETE /api/v1/links/{id}

Delete Link

Permanently delete a shortened link.

GET /api/v1/links/{id}/analytics

Get Analytics

Retrieve detailed analytics data for a specific link.

Error Codes

Code Status Description
200 OK Request completed successfully
400 Bad Request Invalid parameters or malformed request
401 Unauthorized Missing or invalid API key
403 Forbidden API key doesn't have permission for this action
404 Not Found Resource not found
429 Too Many Requests Rate limit exceeded. Wait before retrying.
500 Internal Server Error Server error. Contact support if persists.

Error Response Format

All error responses include a JSON body with error and message fields for debugging.

Authentication

All API requests require authentication using an API key. Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Keep Your API Key Secret

Never expose your API key in client-side code or public repositories. Store it securely in environment variables.

Rate Limits

Free

N/A

API not included

Starter

5,000

requests / hour

Pro

10,000

requests / hour

Business

10,000

requests / hour

The API Is Just One Part of Mobily

Every Mobily URL shortener plan includes 6 tools — the API gives you programmatic access to a complete Canadian digital marketing toolkit.

Short Links + Analytics

Full CRUD via API. Click tracking, device, geo, referrer data.

QR Code Generator

7 types (URL, WiFi, vCard, Email, Phone, SMS, Text) with scan analytics.

Bio Link Pages

Link-in-bio pages with 6 themes, custom colors, fonts, click tracking.

Background Removal

AI-powered. 1-500 images/month by plan. No separate subscription.

SEO Website Audits

Gemini AI insights: SEO, performance, images, mobile, security scoring.

Digital Business Cards

vCard with 6 themes, custom styling, header images, QR sharing.

All 6 tools included with every paid plan. API access on Starter ($19 CAD/mo) and above. See pricing →

Frequently Asked Questions

Is the API free to use?

API access is available on Starter ($19 CAD/mo), Pro ($49/mo), and Business ($129/mo) plans. Rate limits: Starter 5,000/hr, Pro & Business 10,000/hr. The free plan does not include API access.

How do I authenticate with the API?

Generate an API key from your dashboard at /api/keys, then include it as a Bearer token: Authorization: Bearer YOUR_API_KEY. All requests must use HTTPS.

What can I do with the API?

Create short links (POST), list links (GET), get link details and analytics, update links (PUT), delete links (DELETE), and search across your link library. All responses are JSON.

What else do I get besides the API?

Mobily is a 6-in-1 toolkit. Every paid plan includes the API plus a QR code generator, bio link pages, digital business cards, AI background removal, and SEO website audits. All Canadian hosted, all in CAD.

API + 5 More Tools from $19 CAD/mo

REST API, short links, QR codes, bio pages, business cards, background removal & SEO audits. All in one platform. Canadian hosted.