---
title: "Get Shortened URL"
method: GET
path: "/tools/url/{linkId}"
tags: ["tools > url"]
---

# Get Shortened URL

`GET /tools/url/{linkId}`

## Request

- Base URL: `https://api.pinnacle.sh`
- URL: `https://api.pinnacle.sh/tools/url/{linkId}`
- Auth: API key in header `PINNACLE-API-KEY`

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

## Path parameters

- `linkId` string, required

## Response `200`

Returns your URL details.

- PinnacleUrlWithClicks
  - `url` string, required: 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.
  - `config` PinnacleUrlConfig, required
    - `to` string, required: Destination URL that your shortened link redirects to.
    - `expiresAt` string, nullable, required: Expiration date for your shortened link in ISO 8601 format, or null if it's permanent.
  - `clicks` LinkClickEvent[], required: Array of click analytics data for this URL. <br> Click data will be empty if no one has visited your link yet.
    - `accept_language` string, nullable: Accept-Language header value.
    - `accuracy_radius_km` integer, nullable: Accuracy radius for geographic coordinates in kilometers.
    - `asn` integer, nullable: Autonomous System Number.
    - `blocked_reason` string, nullable: Reason why the request was blocked (if applicable).
    - `ch_ua_brand` string, nullable: User-Agent Client Hint brand.
    - `ch_ua_mobile` string, nullable: User-Agent Client Hint mobile indicator.
    - `ch_ua_platform` string, nullable: User-Agent Client Hint platform.
    - `city` string, nullable: City name.
    - `color_depth` integer, nullable: Color depth in bits.
    - `connection_type` string, nullable: Type of internet connection.
    - `country` string, nullable: Country code (ISO 3166-1 alpha-2).
    - `created_at` string, required: Timestamp when the click occurred in ISO 8601 format.
    - `error_details` LinkClickEventErrorDetails: Error details if the request failed.
    - `fbclid` string, nullable: Facebook Click Identifier.
    - `final_url` string, nullable: Final resolved URL after redirects.
    - `fingerprint_id` string, nullable: Unique fingerprint identifier for the client.
    - `gclid` string, nullable: Google Click Identifier.
    - `ip_address` string, nullable: IP address of the visitor (may be anonymized).
    - `ip_chain` string[], nullable: Chain of IP addresses for proxied requests.
    - `is_bot` boolean, nullable: Whether the request was identified as coming from a bot.
    - `latency_ms` integer, nullable: Request latency in milliseconds.
    - `latitude` number, double, nullable: Geographic latitude.
    - `longitude` number, double, nullable: Geographic longitude.
    - `metadata` LinkClickEventMetadata: Additional metadata as JSON object.
    - `method` string, nullable: HTTP method used.
    - `metro_code` integer, nullable: Metro area code.
    - `network_downlink` number, double, nullable: Network downlink speed estimate in Mbps.
    - `network_rtt` integer, nullable: Network round-trip time in milliseconds.
    - `performance_ttfb_ms` integer, nullable: Time to first byte in milliseconds,.
    - `postal_code` string, nullable: Postal/ZIP code.
    - `redirect_hops` integer, nullable: Number of redirect hops to reach final destination.
    - `referrer` string, nullable: The referring URL.
    - `referrer_domain` string, nullable: Domain of the referring URL.
    - `region` string, nullable: Region or state.
    - `resolved_at` string, nullable: Timestamp when the redirect was resolved in ISO 8601 format.
    - `screen_res` string, nullable: Screen resolution.
    - `status_code` integer, nullable: HTTP status code of the response.
    - `timezone_offset_min` integer, nullable: Timezone offset in minutes from UTC.
    - `tor_exit_node` boolean, nullable: Whether the request came from a Tor exit node.
    - `ua_browser` string, nullable: Browser name.
    - `ua_device` string, nullable: Device type.
    - `ua_os` string, nullable: Operating system.
    - `ua_version` string, nullable: Browser version.
    - `user_agent` string, nullable: User agent string from the browser.
    - `utm_campaign` string, nullable: UTM campaign parameter.
    - `utm_content` string, nullable: UTM content parameter.
    - `utm_medium` string, nullable: UTM medium parameter.
    - `utm_source` string, nullable: UTM source parameter.
    - `utm_term` string, nullable: UTM term.

## Other responses

- `400`: Validation failed. The payload has missing required fields and/or invalid types. <br> See https://zod.dev/error-formatting for more information.
- `401`: The request lacks valid authentication credentials or the provided credentials are invalid. <br> Ensure you're including a valid API key in the request headers and that your account has the necessary permissions to access this endpoint.
- `403`: Your subscription does not include access to this feature. <br> This occurs when attempting to use functionality that requires a higher subscription tier. Please upgrade your subscription to access this feature.
- `500`: An unexpected error occurred on Pinnacle's servers while processing your request. <br> If this error persists, please contact support with the request details.

---

[API](https://skmtc.dev/pinnacle/apis/pinnacle-2.md) - [All operations](https://skmtc.dev/pinnacle/apis/pinnacle-2/llms.txt) - [OpenAPI document](https://skmtc.dev/pinnacle/apis/pinnacle-2/revisions/45416dadab79?raw)