Get a message
Retrieve a single message by its public ID. The message must belong to the authenticated workspace and match the API key’s environment (live or test).
Authorizations
API key with an sk_live_ or sk_test_ prefix.
Path Parameters
Public message ID (e.g. msg_...).
Response
The message.
A message row. vars, metadata, and timeline are JSON.
"msg_0a1b2c3d4e5f6g7h"
Null for raw sends.
email, sms, push, web-push Lifecycle status of a message. scheduled is the initial status for a
send with a future scheduledAt; queued is the initial status for an
immediate send. canceled is terminal and reached when a scheduled or
queued message is canceled before dispatch.
suppressed means the provider accepted the request but never attempted
delivery — the recipient address failed validation, or was already
suppressed for this sender. It is distinct from failed, which is a
bounce reported by the receiving mail server.
scheduled, queued, rendered, dispatched, sent, delivered, failed, opted_out, suppressed, blocked, canceled Caller-supplied tags/IDs. Values must be string, number, or boolean.
Raw sends only — whether Mustache interpolation was run over the inline content. Always false for template sends.
Template sends only — the explicit template version pinned by the caller, or null when resolved by environment.
First provider-reported open (email open tracking), or null. Set once; later opens don't update it.
First provider-reported link click, or null. Set once; later clicks don't update it.
When the send was scheduled for, or null for an immediate send.
The Idempotency-Key supplied on the send request, or null if none was provided.