Get Shortened URL

1 import { PinnacleClient } from "rcs-js"; 2 3 async function main() { 4 const client = new PinnacleClient({ 5 environment: "https://api.pinnacle.sh", 6 }); 7 await client.tools.url.get("ePzVxILF"); 8 } 9 main();

1 { 2 "clicks": [ 3 { 4 "created_at": "2025-07-09T23:57:28.889+00:00", 5 "id": 1, 6 "link_id": 13, 7 "accept_language": null, 8 "accuracy_radius_km": null, 9 "asn": null, 10 "blocked_reason": null, 11 "ch_ua_brand": null, 12 "ch_ua_mobile": null, 13 "ch_ua_platform": null, 14 "city": null, 15 "color_depth": null, 16 "connection_type": null, 17 "country": null, 18 "error_details": null, 19 "fbclid": null, 20 "final_url": null, 21 "fingerprint_id": null, 22 "gclid": null, 23 "ip_address": null, 24 "ip_chain": null, 25 "is_bot": false, 26 "latency_ms": 400, 27 "latitude": null, 28 "longitude": null, 29 "metadata": {}, 30 "method": "GET", 31 "metro_code": null, 32 "network_downlink": null, 33 "network_rtt": null, 34 "performance_ttfb_ms": null, 35 "postal_code": null, 36 "redirect_hops": 0, 37 "referrer": null, 38 "referrer_domain": null, 39 "region": null, 40 "resolved_at": null, 41 "screen_res": null, 42 "status_code": 302, 43 "timezone_offset_min": null, 44 "tor_exit_node": null, 45 "ua_browser": null, 46 "ua_device": null, 47 "ua_os": null, 48 "ua_version": null, 49 "user_agent": "vscode-restclient", 50 "utm_campaign": null, 51 "utm_content": null, 52 "utm_medium": null, 53 "utm_source": null, 54 "utm_term": null 55 } 56 ], 57 "config": { 58 "to": "https://pinnacle.sh", 59 "expiresAt": "2023-10-23T16:18:25+00:00" 60 }, 61 "url": "https://pncl.to/ePzVxILF" 62 }

Retrieve configuration and details for your shortened URL using its unique identifier.

Path parameters

linkIdstringRequired

Unique identifier from your shortened URL. For example, for https://pncl.to/ePzVxILF, the linkId is ePzVxILF.

See the response of Create Shortened URL for more information.

Response

Returns your URL details.

clickslist of objects

Array of click analytics data for this URL.

Click data will be empty if no one has visited your link yet.

configobject

urlstring

Your custom shortened link following the format https://pncl.to/{linkId}, where {linkId} is the unique identifier for the URL that can be used with our other endpoint.

Path parameters

Headers

Response

Errors