Skip to main content
GET
Retrieves a Newsletter resource.

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Path Parameters

uuid
string
required

Newsletter identifier

Response

Newsletter resource

id
integer
read-only
uuid
string | null
read-only
name
string
subject
string
owner
object
design
(string | null)[] | null
htmlRaw
string | null
clicks
(string | null)[] | null
unit
object | null
tenant
string<iri-reference>
Example:

"/api/v1/tenants/1"

localCenter
object | null
isGeneral
boolean
default:false
isContacts
boolean
default:false
dateCreated
string<date-time>
read-only
dateSent
string<date-time> | null
status
string
recipients
integer | null
event
object | null
sendToEverybody
boolean | null
isPublic
boolean | null
default:true
slugGo
string | null
publicPreviewLogo
string | null
userList
object | null
scheduledAt
string<date-time> | null
timezone
string | null
senderName
string | null
replyTo
string | null
parentNewsletter
unknown