Skip to main content
GET
/
api
/
urls
curl -X GET "https://snip.sa/api/urls?page=1&limit=20&search=campaign&sortBy=clickCount&sortOrder=desc" \
  -H "X-API-Key: your_api_key_here"

{
  "success": true,
  "data": {
    "urls": [
      {
        "_id": "507f1f77bcf86cd799439011",
        "originalUrl": "https://example.com/page",
        "shortCode": "abc123",
        "title": "Campaign Link",
        "clickCount": 150,
        "isActive": true,
        "createdAt": "2024-01-15T10:30:00.000Z"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 45,
      "pages": 3
    }
  }
}

​
Query Parameters

​
page
number
default:"1"
Page number (minimum: 1)
​
limit
number
default:"20"
Results per page (minimum: 1, maximum: 100)
​
search
string
Search in title, URL, or short code
​
tags
string
Filter by tags (comma-separated)
​
sortBy
string
default:"createdAt"
Sort field: createdAt, clickCount, or title
​
sortOrder
string
default:"desc"
Sort order: asc or desc
​
isActive
boolean
Filter by active status
curl -X GET "https://snip.sa/api/urls?page=1&limit=20&search=campaign&sortBy=clickCount&sortOrder=desc" \
  -H "X-API-Key: your_api_key_here"

{
  "success": true,
  "data": {
    "urls": [
      {
        "_id": "507f1f77bcf86cd799439011",
        "originalUrl": "https://example.com/page",
        "shortCode": "abc123",
        "title": "Campaign Link",
        "clickCount": 150,
        "isActive": true,
        "createdAt": "2024-01-15T10:30:00.000Z"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 45,
      "pages": 3
    }
  }
}