Skip to main content
GET
cURL

Get Shortened URL by urlCode

Returns a single shortened URL. The path parameter is the urlCode (not a numeric database id). Requires scope shortener:read.

HTTP Request

Response

Example

Authorizations

x-api-key
string
header
required

Path Parameters

id
string
required

The urlCode of the shortened URL to retrieve

Response

Shorten URL response

originalUrl
string

The original URL

shortUrl
string

The short URL

urlCode
string

The unique identifier for the shortened URL

organizationId
string

The organization ID

active
boolean

If the URL is active

count
number

The count of clicks of the URL

The link type

Available options:
Coupon,
BrandPage,
Offer