List newsletter links across a set of a channel's editions

GET

/api/v3/channels/{channel}/newsletter-links

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

• Production

Return the distinct enriched links found across a set of this channel’s published editions — either the last numberOfEmails published (mode=recently_published) or a specific list of editions (mode=specific_emails). Built for the automation click-link picker, so results are deduplicated across the whole selection in a single request.

An edition contributes nothing here until Letterhead’s link-enrichment pipeline has crawled it, so a very recently published edition may not yet appear.

v3 endpoints expect a company API key.

Authorizations

• bearerAuth

Parameters

Path Parameters

channel

required

string

The newsletter’s channel identifier (slug).

Query Parameters

api

required

boolean

Required. Set to true.

mode

required

string

recently_published or specific_emails.

numberOfEmails

integer

Required when mode=recently_published. 1-50.

newsletterIds[]

Array<string>

Required when mode=specific_emails. 1-64 letter uniqueIds.

Responses

200

200 OK

Media type application/json

object

items

Array<object>

object

urlMd5

string

url

string

title

string

message

string

total

integer

Example

{
  "items": [
    {
      "urlMd5": "5d41402abc4b2a76b9719d911017c592",
      "url": "https://example.com/an-article",
      "title": "An Example Article"
    }
  ],
  "message": "Newsletter links retrieved.",
  "total": 1
}

400

400 Validation Error — mode is missing/invalid, or the field its value requires (numberOfEmails or newsletterIds) is missing or out of range.

Media type application/json

object

data

Array<string>

items

Array<object>

object

message

string

total

integer

Example

{
  "data": [
    "The mode field is required."
  ],
  "items": [],
  "message": "Looks like the input data doesn't meet our requirements.",
  "total": 0
}

404

404 Not Found — no channel matches channel for this company.

Media type application/json

object

data

Array<object>

object

items

Array<object>

object

message

string

total

integer

Example

{
  "data": [],
  "items": [],
  "message": "Channel not found",
  "total": 0
}