Get all Shortened URLs

cURL

curl --request GET \
  --url https://api.lomadee.com.br/affiliate/shortener/urls \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.lomadee.com.br/affiliate/shortener/urls', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lomadee.com.br/affiliate/shortener/urls",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lomadee.com.br/affiliate/shortener/urls"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.lomadee.com.br/affiliate/shortener/urls")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "originalUrl": "<string>",
      "shortUrl": "<string>",
      "urlCode": "<string>",
      "organizationId": "<string>",
      "active": true,
      "count": 123,
      "linkType": "Coupon"
    }
  ],
  "meta": {
    "total": 123,
    "page": 123,
    "limit": 123,
    "totalPages": 123
  }
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>"
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>"
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>"
}

GET

affiliate

shortener

urls

cURL

curl --request GET \
  --url https://api.lomadee.com.br/affiliate/shortener/urls \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.lomadee.com.br/affiliate/shortener/urls', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lomadee.com.br/affiliate/shortener/urls",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lomadee.com.br/affiliate/shortener/urls"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.lomadee.com.br/affiliate/shortener/urls")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "originalUrl": "<string>",
      "shortUrl": "<string>",
      "urlCode": "<string>",
      "organizationId": "<string>",
      "active": true,
      "count": 123,
      "linkType": "Coupon"
    }
  ],
  "meta": {
    "total": 123,
    "page": 123,
    "limit": 123,
    "totalPages": 123
  }
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>"
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>"
}

{
  "success": false,
  "message": "<string>",
  "code": "<string>"
}

Lists shortened URLs for the authenticated affiliate. Requires scope shortener:read.

Query Parameters

Parameter	Default	Description
`page`	1	Page number
`limit`	10	Items per page (max 100)
`search`	—	Search in original or short URL
`active`	true	Filter by active status
`organizationId`	—	Filter by brand UUID
`type`	—	Link type: Coupon, BrandPage, Offer, Custom
`startAt` / `endAt`	—	Created-at period filter

Response

{
  "data": [
    {
      "originalUrl": "https://...",
      "shortUrl": "https://staging.lmdee.link/abc",
      "urlCode": "abc",
      "organizationId": "...",
      "active": true,
      "linkType": "Offer"
    }
  ],
  "meta": {
    "total": 6,
    "page": 1,
    "limit": 10,
    "totalPages": 1
  }
}

Detail lookup uses urlCode as path parameter: GET /affiliate/shortener/urls/{urlCode}.

Authorizations

x-api-key

string

header

required

Query Parameters

page

integer

default:1

limit

integer

default:10

Required range: x <= 100

string

active

boolean

default:true

organizationId

string

type

string

Filter by link type (Coupon, BrandPage, Offer, Custom)

startAt

string<date-time>

endAt

string<date-time>

Response

Shorten URL response

data

object[]

Show child attributes

API Documentation

Orders

Brands

Channels

Campaigns

Shorten

Products

Get all Shortened URLs