API Documentation

Redirectly API

Create, manage, and analyze your short links programmatically with our powerful REST API

API Reference

Quick Start

Get up and running with the Redirectly API in minutes. All endpoints require authentication via API key.

Base URL

https://redirectly.app/api

Content Type

application/json

Authentication

All API requests require authentication using your API key as a Bearer token in the Authorization header.

bash

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://redirectly.app/api/links

Security Note

Keep your API key secure and never expose it in client-side code. Generate new keys from your dashboard if compromised.

Error Codes

400

Bad Request

Invalid input or missing required fields

401

Unauthorized

Missing or invalid API key

403

Forbidden

Access denied for this resource

404

Not Found

Requested resource does not exist

409

Conflict

Resource already exists (e.g. duplicate username)

429

Too Many Requests

Rate limit exceeded

500

Internal Server Error

Something went wrong on our end

Example Error Response

json

{
  "error": "Unauthorized",
  "message": "Invalid API key provided"
}

Links

Manage your permanent short links

GET

List Links

Retrieve all your permanent links

Endpoint

GET /api/links

Example Request

bash

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://redirectly.app/api/links

Response

json

[
  {
    "slug": "my-awesome-link",
    "target": "https://example.com",
    "click_count": 42,
    "url": "https://yourname.redirectly.app/my-awesome-link",
    "created_at": "2024-06-01T12:00:00Z",
    "updated_at": "2024-06-01T12:00:00Z"
  }
]

POST

Create Link

Create a new permanent short link

Endpoint

POST /api/links

Request Body

json

{
  "slug": "my-awesome-link",
  "target": "https://example.com"
}

Example Request

bash

curl -X POST \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"slug": "my-awesome-link", "target": "https://example.com"}' \
  https://redirectly.app/api/links

Response

json

{
  "slug": "my-awesome-link",
  "target": "https://example.com",
  "url": "https://yourname.redirectly.app/my-awesome-link",
  "click_count": 0,
  "created_at": "2024-06-01T12:00:00Z"
}

PUT

Update Link

Update the target URL of a permanent link

Endpoint

PUT /api/links/[slug]

Parameters

slug(path parameter) - The slug of the link to update

Request Body

json

{
  "target": "https://new-example.com"
}

Example Request

bash

curl -X PUT \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"target": "https://new-example.com"}' \
  https://redirectly.app/api/links/my-awesome-link

Response

json

{
  "slug": "my-awesome-link",
  "target": "https://new-example.com",
  "user_id": "user-uuid",
  "created_at": "2024-06-01T12:00:00Z",
  "updated_at": "2024-06-01T12:00:00Z"
}

DELETE

Delete Link

Remove a permanent link

Endpoint

DELETE /api/links/[slug]

Parameters

slug(path parameter) - The slug of the link to delete

Example Request

bash

curl -X DELETE \
  -H "Authorization: Bearer YOUR_API_KEY" \
  https://redirectly.app/api/links/my-awesome-link

Response

json

{
  "message": "Link deleted successfully"
}

Temporary Links

Create expiring short links

POST

Create Temp Link

Generate temporary links with expiration

Endpoint

POST /api/v1/temp-links

Request Body

json

{
  "target": "https://example.com",
  "slug": "optional-custom-slug",
  "ttlSeconds": 900
}

Parameters

target(required) - The URL to redirect to

slug(optional) - Custom slug, auto-generated if not provided

ttlSeconds(optional) - Time to live in seconds, defaults to 900 (15 minutes)

Example Request

bash

curl -X POST \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"target": "https://example.com", "ttlSeconds": 3600}' \
  https://redirectly.app/api/v1/temp-links

Response

json

{
  "slug": "abc123",
  "target": "https://example.com",
  "url": "https://yourname.redirectly.app/abc123",
  "expires_at": "2024-06-01T12:15:00Z",
  "created_at": "2024-06-01T12:00:00Z"
}

Analytics

Track link performance

GET

Get Stats

Access detailed analytics and metrics

Endpoint

GET /api/stats

Example Request

bash

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://redirectly.app/api/stats

Response

json

{
  "dailyStats": [
    { "day": "2024-06-01", "total": 45 },
    { "day": "2024-06-02", "total": 38 },
    { "day": "2024-06-03", "total": 52 }
  ],
  "totalClicks": 1250,
  "totalLinks": 15
}

Profile

User account management

GET

Get Profile

Retrieve user profile information

Endpoint

GET /api/profile

Example Request

bash

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://redirectly.app/api/profile

Response

json

{
  "id": "user-uuid",
  "username": "yourname",
  "created_at": "2024-06-01T12:00:00Z",
  "updated_at": "2024-06-01T12:00:00Z"
}

POST

Update Profile

Update user profile settings

Endpoint

POST /api/profile

Request Body

json

{
  "username": "new-username"
}

Parameters

username(required) - 3-20 characters, alphanumeric and hyphens only

Example Request

bash

curl -X POST \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"username": "new-username"}' \
  https://redirectly.app/api/profile

Response

json

{
  "id": "user-uuid",
  "username": "new-username",
  "created_at": "2024-06-01T12:00:00Z",
  "updated_at": "2024-06-01T12:00:00Z"
}

Mobile Integration

Mobile app deep linking

GET

Apple App Association

iOS app site association

GET

Android Asset Links

Android app verification

Need Help?

Check out our dashboard for more tools, or contact our support team if you need assistance.