ShortURL API

v1
Base:

ShortURL API Documentation

API for creating and managing short links. All endpoints require authentication via API token.

Authentication: Send token as X-Api-Token header or ?token= query parameter.

POST /Api/v1/Links/Create Create a short link
Parameters
NameTypeRequiredValue
Urlstring * Yes
CampaignIdstring No
GET /Api/v1/Links List all links (with filters & pagination)
Parameters
NameTypeRequiredValue
campaignIdstringNo
isActiveboolNo
pageintNo
pageSizeintNo
GET /Api/v1/Links/{id} Get link details by ID
Parameters
NameTypeRequiredValue
idint * Yes
GET /Api/v1/Links/ByCode/{code} Get link by short code
Parameters
NameTypeRequiredValue
codestring * Yes
GET /Api/v1/Links/{id}/Stats Get link visit statistics
Parameters
NameTypeRequiredValue
idint * Yes
recentCountintNo
POST /Api/v1/Links/{id}/Update Update a link
Parameters
NameTypeRequiredValue
idint (path) * Yes
UrlstringNo
ExpiryDatedatetimeNo
IsActiveboolNo
POST /Api/v1/Links/{id}/Delete Deactivate a link (soft delete)
Parameters
NameTypeRequiredValue
idint * Yes