List a letter's clicked links

GET

/api/v3/letters/{letterUuid}/click-links

const url = 'https://api.tryletterhead.com/api/v3/letters/example/click-links?api=true';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.tryletterhead.com/api/v3/letters/example/click-links?api=true' \
  --header 'Authorization: Bearer <token>'

Return the distinct link URLs that at least one reader has clicked on in this letter. Unlike listALettersLinks (every link the newsletter contains), this only includes links with recorded click activity.

Authorizations

bearerAuth

Parameters

Path Parameters

letterUuid

required

string

The letter’s unique identifier — an alphanumeric string around ten characters, e.g. ludctamgd6.

Query Parameters

api

required

boolean

When true, tells the endpoint you are authenticating with a company API key (the key you generate under a company’s administrative settings) rather than a logged-in user session. For API integrations you will almost always set this to true.

Responses

200

Clicked link URLs retrieved

application/json

object

items

Array<string>

message

string

total

integer

Example

{
  "items": [
    "https://www.nytimes.com/interactive/2025/movies/best-movies-21st-century.html"
  ],
  "message": "",
  "total": 1
}

Still can’t find what you need? Contact support.