Read a newsletter and audience snapshot
Returns stored content without raw recipient arrays, derived delivery totals, current-versus-snapshot audience explanation, and the first50 recipient ids. Saved addresses remain visible with email drift flags; sending resolves current tenant donor addresses. Missing record returns404 with status=success in the legacy envelope. Requires permission: one of newsletter.
curl --request GET \
--url https://api.gratona.com/v1/admin/newsLetters/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.gratona.com/v1/admin/newsLetters/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.gratona.com/v1/admin/newsLetters/{id}', 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/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.gratona.com/v1/admin/newsLetters/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.gratona.com/v1/admin/newsLetters/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/newsLetters/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"id": 42,
"client_id": 42,
"title": "Education field update",
"message": "<p>Thank you for supporting education.</p>",
"design": "{`body`:{}}",
"status": "draft",
"type": "newsletter",
"sender_email": "admin@example.org",
"sender_name": "Jane Admin",
"attachment": "https://example.org/newsletter.pdf",
"scheduled_at": "2026-10-20T12:00:00Z",
"timezone": "Africa/Kampala",
"scheduled_timezone": "Africa/Kampala",
"schedule_source": "calendar",
"timing_recommendation_id": "550e8400-e29b-41d4-a716-446655440000",
"schedule_claim_id": "550e8400-e29b-41d4-a716-446655440000",
"claimed_at": "2026-10-20T12:00:00Z",
"recipient_count": 1,
"audience_selection": {
"version": 2,
"mode": "static",
"captured_at": "2026-10-20T12:00:00Z",
"tag_operator": "any",
"tags": [
"Education"
],
"tag_match_count": 1,
"individual_donor_ids": [
42
],
"excluded_tag_donor_ids": [
42
],
"recipient_count": 1
},
"created_at": "2026-10-20T12:00:00Z",
"updated_at": "2026-10-20T12:00:00Z",
"delivery_status": "partially_sent",
"delivery_total": 1,
"delivery_sent": 1,
"delivery_failed": 1,
"delivery_unconfirmed": 1,
"delivery_pending": 1,
"delivery_skipped": 1
},
"donors": [
{
"email": "jane@example.org",
"current_email": "jane.new@example.org",
"email_drifted": true,
"name": "Jane Donor",
"id": 42,
"tags": "Education,Monthly"
}
],
"recipient_pagination": {
"current_page": 1,
"per_page": 1,
"total": 1,
"last_page": 1
},
"audience": {
"version": 2,
"mode": "static",
"captured_at": "2026-10-20T12:00:00Z",
"capture_time_estimated": true,
"snapshot_recipient_count": 1,
"tag_operator": "any",
"tags": [
"Education"
],
"tag_match_count_at_capture": 1,
"current_tag_member_count": 1,
"not_included_count": 1,
"manual_exclusion_count": 1,
"new_tag_member_count": 1,
"no_longer_matches_count": 1
},
"status": "success",
"message": "Newsletter successfully updated"
}{
"message": "Unauthorized",
"status": "error"
}{
"message": "Not Found",
"status": "error"
}Authorizations
Passport bearer token authentication for legacy admin sessions.
Path Parameters
Id in the current organization.
Response
Operation result.
Read/edit/audience-save payload. message is included only after mutations; detail includes at most the first50 recipient ids.
Derived delivery results; sent means provider acceptance, separate from delivered confirmation.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Snapshot-versus-current tag facts. All/manual fresh mode omits tag facts; legacy or manual selections can return null.
Show child attributes
Show child attributes
"success"
"Newsletter successfully updated"
curl --request GET \
--url https://api.gratona.com/v1/admin/newsLetters/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.gratona.com/v1/admin/newsLetters/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.gratona.com/v1/admin/newsLetters/{id}', 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/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.gratona.com/v1/admin/newsLetters/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.gratona.com/v1/admin/newsLetters/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/newsLetters/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"id": 42,
"client_id": 42,
"title": "Education field update",
"message": "<p>Thank you for supporting education.</p>",
"design": "{`body`:{}}",
"status": "draft",
"type": "newsletter",
"sender_email": "admin@example.org",
"sender_name": "Jane Admin",
"attachment": "https://example.org/newsletter.pdf",
"scheduled_at": "2026-10-20T12:00:00Z",
"timezone": "Africa/Kampala",
"scheduled_timezone": "Africa/Kampala",
"schedule_source": "calendar",
"timing_recommendation_id": "550e8400-e29b-41d4-a716-446655440000",
"schedule_claim_id": "550e8400-e29b-41d4-a716-446655440000",
"claimed_at": "2026-10-20T12:00:00Z",
"recipient_count": 1,
"audience_selection": {
"version": 2,
"mode": "static",
"captured_at": "2026-10-20T12:00:00Z",
"tag_operator": "any",
"tags": [
"Education"
],
"tag_match_count": 1,
"individual_donor_ids": [
42
],
"excluded_tag_donor_ids": [
42
],
"recipient_count": 1
},
"created_at": "2026-10-20T12:00:00Z",
"updated_at": "2026-10-20T12:00:00Z",
"delivery_status": "partially_sent",
"delivery_total": 1,
"delivery_sent": 1,
"delivery_failed": 1,
"delivery_unconfirmed": 1,
"delivery_pending": 1,
"delivery_skipped": 1
},
"donors": [
{
"email": "jane@example.org",
"current_email": "jane.new@example.org",
"email_drifted": true,
"name": "Jane Donor",
"id": 42,
"tags": "Education,Monthly"
}
],
"recipient_pagination": {
"current_page": 1,
"per_page": 1,
"total": 1,
"last_page": 1
},
"audience": {
"version": 2,
"mode": "static",
"captured_at": "2026-10-20T12:00:00Z",
"capture_time_estimated": true,
"snapshot_recipient_count": 1,
"tag_operator": "any",
"tags": [
"Education"
],
"tag_match_count_at_capture": 1,
"current_tag_member_count": 1,
"not_included_count": 1,
"manual_exclusion_count": 1,
"new_tag_member_count": 1,
"no_longer_matches_count": 1
},
"status": "success",
"message": "Newsletter successfully updated"
}{
"message": "Unauthorized",
"status": "error"
}{
"message": "Not Found",
"status": "error"
}