List newsletters with delivery summaries
Returns newsletters newest updated_at/id first. Pagination is clamped; title search is trimmed to255 characters. Invalid filterData becomes no filter. statusView=overview collapses partially_sent/unconfirmed to sent, except explicit filters for those states force detailed view. status_counts includes all tenant newsletters before title/status filtering. Requires permission: one of newsletter.
curl --request POST \
--url https://api.gratona.com/v1/admin/newsLetters \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"pageIndex": 1,
"pageSize": 10,
"filterData": "drafts",
"query": "Education",
"statusView": "overview"
}
'import requests
url = "https://api.gratona.com/v1/admin/newsLetters"
payload = {
"pageIndex": 1,
"pageSize": 10,
"filterData": "drafts",
"query": "Education",
"statusView": "overview"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
pageIndex: 1,
pageSize: 10,
filterData: 'drafts',
query: 'Education',
statusView: 'overview'
})
};
fetch('https://api.gratona.com/v1/admin/newsLetters', 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.gratona.com/v1/admin/newsLetters",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'pageIndex' => 1,
'pageSize' => 10,
'filterData' => 'drafts',
'query' => 'Education',
'statusView' => 'overview'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.gratona.com/v1/admin/newsLetters"
payload := strings.NewReader("{\n \"pageIndex\": 1,\n \"pageSize\": 10,\n \"filterData\": \"drafts\",\n \"query\": \"Education\",\n \"statusView\": \"overview\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.gratona.com/v1/admin/newsLetters")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"pageIndex\": 1,\n \"pageSize\": 10,\n \"filterData\": \"drafts\",\n \"query\": \"Education\",\n \"statusView\": \"overview\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/newsLetters")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"pageIndex\": 1,\n \"pageSize\": 10,\n \"filterData\": \"drafts\",\n \"query\": \"Education\",\n \"statusView\": \"overview\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"data": [
{
"id": 42,
"title": "Education field update",
"status": "draft",
"scheduled_at": "2026-10-20T12:00:00Z",
"timezone": "Africa/Kampala",
"scheduled_timezone": "Africa/Kampala",
"sender_name": "Jane Admin",
"created_at": "2026-10-20T12:00:00Z",
"updated_at": "2026-10-20T12:00:00Z",
"recipient_count": 1,
"delivery_status": "partially_sent",
"delivery_total": 1,
"delivery_sent": 1,
"delivery_failed": 1,
"delivery_unconfirmed": 1,
"delivery_pending": 1,
"delivery_skipped": 1,
"list_status": "sent"
}
],
"current_page": 1,
"per_page": 1,
"total": 1,
"last_page": 1,
"from": 1,
"to": 1,
"first_page_url": "<string>",
"last_page_url": "<string>",
"next_page_url": "<string>",
"prev_page_url": "<string>",
"path": "<string>",
"links": [
{
"url": "<string>",
"label": "<string>",
"active": true
}
]
},
"status_counts": {
"total": 1,
"draft": 1,
"scheduled": 1,
"sending": 1,
"sent": 1,
"failed": 1,
"skipped": 1,
"partially_sent": 1,
"unconfirmed": 1
},
"status_view": "overview",
"status": "success"
}{
"message": "Unauthorized",
"status": "error"
}Authorizations
Passport bearer token authentication for legacy admin sessions.
Body
Validated request fields for this operation.
One-based requested page; values below1 clamp to1.
x >= 11
Rows per page clamped1..100.
1 <= x <= 10010
Lifecycle/delivery bucket; invalid values select all.
, drafts, sent, scheduled, sending, failed, skipped, partially_sent, unconfirmed "drafts"
Case/database-dependent title substring search.
255"Education"
overview groups partial/unconfirmed under sent; otherwise detailed.
"overview"
curl --request POST \
--url https://api.gratona.com/v1/admin/newsLetters \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"pageIndex": 1,
"pageSize": 10,
"filterData": "drafts",
"query": "Education",
"statusView": "overview"
}
'import requests
url = "https://api.gratona.com/v1/admin/newsLetters"
payload = {
"pageIndex": 1,
"pageSize": 10,
"filterData": "drafts",
"query": "Education",
"statusView": "overview"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
pageIndex: 1,
pageSize: 10,
filterData: 'drafts',
query: 'Education',
statusView: 'overview'
})
};
fetch('https://api.gratona.com/v1/admin/newsLetters', 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.gratona.com/v1/admin/newsLetters",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'pageIndex' => 1,
'pageSize' => 10,
'filterData' => 'drafts',
'query' => 'Education',
'statusView' => 'overview'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.gratona.com/v1/admin/newsLetters"
payload := strings.NewReader("{\n \"pageIndex\": 1,\n \"pageSize\": 10,\n \"filterData\": \"drafts\",\n \"query\": \"Education\",\n \"statusView\": \"overview\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.gratona.com/v1/admin/newsLetters")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"pageIndex\": 1,\n \"pageSize\": 10,\n \"filterData\": \"drafts\",\n \"query\": \"Education\",\n \"statusView\": \"overview\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/newsLetters")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"pageIndex\": 1,\n \"pageSize\": 10,\n \"filterData\": \"drafts\",\n \"query\": \"Education\",\n \"statusView\": \"overview\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"data": [
{
"id": 42,
"title": "Education field update",
"status": "draft",
"scheduled_at": "2026-10-20T12:00:00Z",
"timezone": "Africa/Kampala",
"scheduled_timezone": "Africa/Kampala",
"sender_name": "Jane Admin",
"created_at": "2026-10-20T12:00:00Z",
"updated_at": "2026-10-20T12:00:00Z",
"recipient_count": 1,
"delivery_status": "partially_sent",
"delivery_total": 1,
"delivery_sent": 1,
"delivery_failed": 1,
"delivery_unconfirmed": 1,
"delivery_pending": 1,
"delivery_skipped": 1,
"list_status": "sent"
}
],
"current_page": 1,
"per_page": 1,
"total": 1,
"last_page": 1,
"from": 1,
"to": 1,
"first_page_url": "<string>",
"last_page_url": "<string>",
"next_page_url": "<string>",
"prev_page_url": "<string>",
"path": "<string>",
"links": [
{
"url": "<string>",
"label": "<string>",
"active": true
}
]
},
"status_counts": {
"total": 1,
"draft": 1,
"scheduled": 1,
"sending": 1,
"sent": 1,
"failed": 1,
"skipped": 1,
"partially_sent": 1,
"unconfirmed": 1
},
"status_view": "overview",
"status": "success"
}{
"message": "Unauthorized",
"status": "error"
}