Supercharge your
Link Management
A high-concurrency URL shortener platform supporting isolated tenant organizations, custom subdomain branding, API access, and millisecond redirections.
Register New Organization
Active Tenants Directory
2 RegisteredAcme Corporation
69 URLs
slug: acme
Prefix: acme-
API Key
acme_api_secret_key_777
Globex Industries
3 URLs
slug: globex
Prefix: gbx-
API Key
globex_api_secret_key_888
Architecture
Dynamic WAL
Database
Prisma SQLite
ID Coding
Base-62 Random
Developer REST API Reference
Integrate real-time, high-speed link shortening programmatically inside your workflows.
Authentication header:
X-API-Key: YOUR_API_KEY
POST
/api/v1/urls
— Create Shortened Link
Request & Response Schema
// Response includes tenant & shortUrl
{
"success": true,
"url": {
"id": "c7b3a1a0...",
"tenant": "acme",
"shortCode": "prisma-repo",
"shortUrl": "http://acme.lvh.me:3000/prisma-repo",
"title": "Prisma ORM"
}
}
Implementation Examples
curl -X POST https://shorten.bboxps.space/api/v1/urls \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"originalUrl": "https://github.com/prisma",
"shortCode": "prisma-repo",
"title": "Prisma ORM"
}'
GET
/api/v1/urls
— List Shortened Links
Response Payload Schema
{
"success": true,
"urls": [
{
"id": "cl...89",
"tenant": "acme",
"originalUrl": "https://...",
"shortCode": "prisma-repo",
"shortUrl": "http://acme.lvh.me:3000/prisma-repo",
"clicksCount": 42
}
]
}
Implementation Examples
curl -X GET https://shorten.bboxps.space/api/v1/urls \
-H "X-API-Key: YOUR_API_KEY"
GET
/api/v1/urls/:id
— Retrieve Link by ID
Response Schema (Telemetry Active)
{
"success": true,
"url": { "id": "cl...", "clicksCount": 15 },
"recentClicks": [
{ "referer": "Twitter", "userAgent": "Chrome" }
]
}
Implementation Examples
curl -X GET https://shorten.bboxps.space/api/v1/urls/clv8d927a0001ux4g8m9z5k7 \
-H "X-API-Key: YOUR_API_KEY"
GET
/api/v1/urls/by-code/:shortCode
— Retrieve Link by Short Code
Response Schema (Telemetry Active)
{
"success": true,
"url": { "id": "cl...", "clicksCount": 15 },
"recentClicks": [
{ "referer": "Twitter", "userAgent": "Chrome" }
]
}
Implementation Examples
curl -X GET https://shorten.bboxps.space/api/v1/urls/by-code/acme-prisma \
-H "X-API-Key: YOUR_API_KEY"
PATCH
/api/v1/urls/:id
— Update Shortened Link
Payload Schema
{
"originalUrl": "https://new-destination.com", // (Optional)
"title": "Updated Campaign Title", // (Optional)
"shortCode": "new-slug", // (Optional)
"expiresAt": "2026-12-31T23:59:59.000Z" // (Optional)
}
Implementation Examples
curl -X PATCH https://shorten.bboxps.space/api/v1/urls/clv8d927a0001ux4g8m9z5k7 \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"originalUrl": "https://new-destination.com",
"title": "Updated Campaign Title"
}'
DELETE
/api/v1/urls/:id
— Delete Shortened Link & Stats
Response Payload Schema
{
"success": true,
"message": "URL and all its analytics deleted."
}
Implementation Examples
curl -X DELETE https://shorten.bboxps.space/api/v1/urls/clv8d927a0001ux4g8m9z5k7 \
-H "X-API-Key: YOUR_API_KEY"
POST
/api/v1/urls/bulk-delete
— Bulk Delete Multiple Shortened Links
Request Payload Schema
{
"ids": [
"clv8d927a0001ux4g8m9z5k7",
"clv8d927a0002ux4g8m9z5k8"
]
}
Response Payload Schema
{
"success": true,
"message": "Successfully deleted 2 URLs and all their analytics.",
"deletedCount": 2
}
Implementation Examples
curl -X POST https://shorten.bboxps.space/api/v1/urls/bulk-delete \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"ids": ["clv8d927a0001ux4g8m9z5k7", "clv8d927a0002ux4g8m9z5k8"]
}'