API documentation

A token-authenticated REST API for short links, campaigns, QR codes, and analytics.

Getting started

Base URL: https://url.skilladders.com/api. Create a token under API tokens in your dashboard, or exchange your credentials at POST /api/login. Send it as a bearer token:

Authorization: Bearer YOUR_TOKEN

Response envelope

Every response — success or failure — uses the same shape:

{
  "success": true,
  "message": "Short link created successfully.",
  "data": { }
}

Rate limits

120 requests per minute per token on authenticated endpoints, and 6 per minute on POST /api/login. Exceeding a limit returns 429. API access requires a plan that includes it — see pricing.

Endpoints

POST /api/login

Exchange email + password for a token

curl -X POST https://url.skilladders.com/api/login -d "email=you@example.com&password=…&device_name=cli"
GET /api/me

Current authenticated account

curl https://url.skilladders.com/api/me -H "Authorization: Bearer TOKEN"
POST /api/logout

Revoke the token used for this request

curl -X POST https://url.skilladders.com/api/logout -H "Authorization: Bearer TOKEN"
GET /api/links

List your short links (paginated)

curl https://url.skilladders.com/api/links -H "Authorization: Bearer TOKEN"
POST /api/links

Create a short link

curl -X POST https://url.skilladders.com/api/links -H "Authorization: Bearer TOKEN" -d "original_url=https://example.com&alias=promo"
GET /api/links/{id}

Retrieve a link

curl https://url.skilladders.com/api/links/{id} -H "Authorization: Bearer TOKEN"
PUT /api/links/{id}

Update a link

curl -X PUT https://url.skilladders.com/api/links/{id} -H "Authorization: Bearer TOKEN" -d "title=New title"
DELETE /api/links/{id}

Delete a link

curl -X DELETE https://url.skilladders.com/api/links/{id} -H "Authorization: Bearer TOKEN"
GET /api/links/{id}/analytics

Link analytics (from/to)

curl "https://url.skilladders.com/api/links/{id}/analytics?from=2026-07-01&to=2026-07-31" -H "Authorization: Bearer TOKEN"
GET /api/links/{id}/qr

QR code (data URI)

curl "https://url.skilladders.com/api/links/{id}/qr?format=png&size=500" -H "Authorization: Bearer TOKEN"
GET /api/campaigns

List campaigns

curl https://url.skilladders.com/api/campaigns -H "Authorization: Bearer TOKEN"
POST /api/campaigns

Create a campaign

curl -X POST https://url.skilladders.com/api/campaigns -H "Authorization: Bearer TOKEN" -d "name=Summer&code=summer&status=active"
GET /api/account/usage

Plan limits and current usage

curl https://url.skilladders.com/api/account/usage -H "Authorization: Bearer TOKEN"

Errors

Validation failures return 422 with the offending fields; an invalid or revoked token returns 401; requesting a resource you do not own returns 403. Internal errors never leak exception details.

Ready to build?

Create an account and issue your first token in a minute.

Get started