GET
/
affiliate
/
shorten
/
urls
cURL
curl --request GET \
  --url https://api-beta.lomadee.com.br/affiliate/shorten/urls \
  --header 'x-api-key: <api-key>'
[
  {
    "data": [
      {
        "originalUrl": "<string>",
        "shortUrl": "<string>",
        "urlCode": "<string>",
        "organizationId": "<string>",
        "active": true,
        "count": 123,
        "linkType": "Coupon"
      }
    ],
    "meta": {
      "total": 123,
      "page": 123,
      "limit": 123,
      "totalPages": 123
    }
  }
]

​
Get all URLs Shortened

​
HTTP Request

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
limit
integer

The maximum number of results to return

​
page
integer

The page number to return

​
organizationId
string

Brand identifier to filter shortened URLs

​
featureId
string

Unique identifier used to generate campaign URLs for coupons or offers.

Required when type is set to Coupon or Offer. This ID is used to track and attribute conversions to specific campaigns. To get this ID, you can use the GET /affiliate/campaigns endpoint.

​
type
enum<string>
required

Specifies the type of URL to be generated.

Available options:

BrandPage: Generates a URL for the brand's main website.

Coupon: Generates a URL for a coupon campaign. Requires featureId.

Offer: Generates a URL for a promotional offer. Requires featureId.

Available options:
Coupon,
BrandPage,
Offer

Response

200 - application/json

Shorten URL response

The response is of type object[].