Skip to content
/
Search Newsletters

Search Newsletters

Tool name: search-newsletters

Lists the email newsletters of a KlickTipp account, newest first: newsletter ID, email ID, name, delivery state, creation and dispatch moment, split-test flag and deep links. Narrow by a name fragment, by status (draft, scheduled, outgoing, sent) and by two half-open time windows on creation (createdFrom/createdBefore) and dispatch (sendDateFrom/sendDateBefore), ISO 8601 with UTC offset. Paged by cursor: hand nextCursor back unchanged with the same filters. A draft has no dispatch moment and never matches a sendDate window; a split test has no single email, its emailId is null. Subject, content, audience and statistics are read per newsletter through get-newsletter. SMS newsletters, autoresponders and automations are not included.

Input schema

querynull or string, <= 250 characters

Text the name of a newsletter has to contain; omit to list them all

Default:null
statusnull or string

Only newsletters in this delivery state: "draft", "scheduled", "outgoing" or "sent"

Default:null
Enum:"draft""scheduled""outgoing""sent"
createdFromnull or string^\d{4}-\d{2}-\d{2}[Tt ]\d{2}:\d{2}(:\d{2})?([...

Created at or after this moment, ISO 8601 with UTC offset ("2026-09-01T10:00:00+02:00")

Default:null
createdBeforenull or string^\d{4}-\d{2}-\d{2}[Tt ]\d{2}:\d{2}(:\d{2})?([...

Only newsletters created before this moment, exclusive, same format

Default:null
sendDateFromnull or string^\d{4}-\d{2}-\d{2}[Tt ]\d{2}:\d{2}(:\d{2})?([...

Dispatch moment at or after this one, same format; a draft has none and never matches

Default:null
sendDateBeforenull or string^\d{4}-\d{2}-\d{2}[Tt ]\d{2}:\d{2}(:\d{2})?([...

Only newsletters whose dispatch moment lies before this one, exclusive, same format

Default:null
limitnull or integer, [ 1 .. 100 ]

How many newsletters to return at most, 1 to 100, 25 by default

Default:null
cursornull or string, [ 8 .. 200 ] characters

nextCursor of the previous page, with the same filters; omit for the first page

Default:null
accountIdnull or integer, >= 1

User ID of the account; omit for the account the access token works in

Default:null
Input example
{
  "query": null,
  "status": "draft",
  "createdFrom": null,
  "createdBefore": null,
  "sendDateFrom": null,
  "sendDateBefore": null,
  "limit": null,
  "cursor": null,
  "accountId": null
}

Output schema

accountIdintegerrequired
countintegerrequired
hasNextPagebooleanrequired
nextCursorstring or nullrequired
newslettersArray of objectsrequired
Output example
{
  "accountId": 0,
  "count": 0,
  "hasNextPage": true,
  "nextCursor": "string",
  "newsletters": [
    {
      "newsletterId": 0,
      "emailId": 0,
      "name": "string",
      "newsletterStatus": "string",
      "createdAt": "string",
      "sendDate": "string",
      "isSplitTest": true,
      "sent": 0,
      "opensTotal": 0,
      "clicksTotal": 0,
      "editUrl": "string",
      "statisticsUrl": "string",
      "contentUrl": "string"
    }
  ]
}