Get by Alias

curl --request GET \
  --url https://jmpy.me/api/v1/short-urls/{alias} \
  --header 'Authorization: Bearer <token>'

{
  "id": "<string>",
  "short_code": "<string>",
  "short_url": "<string>",
  "original_url": "<string>",
  "click_count": 123,
  "created_at": "<string>",
  "expires_at": "<string>",
  "tracking_enabled": true
}

GET

short-urls

{alias}

Get by Alias

curl --request GET \
  --url https://jmpy.me/api/v1/short-urls/{alias} \
  --header 'Authorization: Bearer <token>'

{
  "id": "<string>",
  "short_code": "<string>",
  "short_url": "<string>",
  "original_url": "<string>",
  "click_count": 123,
  "created_at": "<string>",
  "expires_at": "<string>",
  "tracking_enabled": true
}

Get the full details and current state of a short URL by providing its custom alias (or short code). This is useful for retrieving analytics summaries, checking expiration dates, or verifying destination URLs.

Path Parameters

alias

string

required

The custom alias (or short code) of the short URL.

Response

string

Unique identifier (UUID).

short_code

string

The system short code or custom alias.

short_url

string

The full short URL.

original_url

string

The destination URL.

click_count

integer

Total number of clicks tracked.

created_at

string

Creation timestamp (ISO 8601).

expires_at

string

expiration timestamp (ISO 8601) or null.

tracking_enabled

boolean

Whether tracking is active.

Request Examples

curl -X GET "https://jmpy.me/api/v1/short-urls/summer2024" \
  -H "Authorization: Bearer YOUR_API_KEY"

const fetch = require('node-fetch');

const alias = 'summer2024';
const response = await fetch(`https://jmpy.me/api/v1/short-urls/${alias}`, {
  headers: { 'Authorization': 'Bearer YOUR_API_KEY' }
});
const data = await response.json();

import axios from 'axios';

const alias = 'summer2024';
const response = await axios.get(
  `https://jmpy.me/api/v1/short-urls/${alias}`,
  { headers: { 'Authorization': 'Bearer YOUR_API_KEY' } }
);

import requests

alias = "summer2024"
url = f"https://jmpy.me/api/v1/short-urls/{alias}"
headers = {"Authorization": "Bearer YOUR_API_KEY"}

response = requests.get(url, headers=headers)

<?php
$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://jmpy.me/api/v1/short-urls/summer2024', [
    'headers' => ['Authorization' => 'Bearer YOUR_API_KEY']
]);
?>

package main

import "net/http"

func main() {
    req, _ := http.NewRequest("GET", "https://jmpy.me/api/v1/short-urls/summer2024", nil)
    req.Header.Add("Authorization", "Bearer YOUR_API_KEY")
    
    http.DefaultClient.Do(req)
}

import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.URI;
import java.net.http.HttpResponse;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://jmpy.me/api/v1/short-urls/summer2024"))
    .header("Authorization", "Bearer YOUR_API_KEY")
    .GET()
    .build();
client.send(request, HttpResponse.BodyHandlers.ofString());

Response Examples

200 OK
404 Not Found

{
  "success": true,
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "short_code": "summer2024",
    "short_url": "https://jmpy.me/summer2024",
    "original_url": "https://example.com/summer-sale",
    "custom_alias": "summer2024",
    "click_count": 1250,
    "created_at": "2024-01-01T12:00:00Z",
    "expires_at": null,
    "tracking_enabled": true
  }
}

{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "Short URL not found"
  }
}

List All

See all your created short URLs

Update

Modify this short URL

Create with Alias Update Alias

​Path Parameters

​Response

​Request Examples

​Response Examples

​Related Endpoints

List All

Update

Path Parameters

Response

Request Examples

Response Examples

Related Endpoints