email.broadcast.get
curl --request POST \
--url https://platform.trylath.com/email/broadcast/get \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"broadcastId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({broadcastId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'})
};
fetch('https://platform.trylath.com/email/broadcast/get', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://platform.trylath.com/email/broadcast/get"
payload = { "broadcastId": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://platform.trylath.com/email/broadcast/get"
payload := strings.NewReader("{\n \"broadcastId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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))
}{
"activityId": "<string>",
"result": {
"broadcast": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"template": "<string>",
"topic": "<string>",
"segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"variables": "<unknown>",
"scheduledAt": "2023-11-07T05:31:56Z",
"status": "draft",
"counts": null,
"sentAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"from": "<string>",
"subject": "<string>"
},
"readiness": {
"ok": true,
"problems": [
{
"code": "<string>",
"message": "<string>",
"fix": "<string>"
}
]
},
"progress": {
"inFlight": 0,
"done": true
}
}
}email.broadcast.get
Returns a broadcast with its status, the fan-out counts (recipients, queued, suppressed, held), and — once sent — progress: what has actually become of its messages, counted live from the messages themselves, so delivered and bounced totals keep moving as receipts arrive. For drafts, returns what still blocks sending.
POST
/
email
/
broadcast
/
get
email.broadcast.get
curl --request POST \
--url https://platform.trylath.com/email/broadcast/get \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"broadcastId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({broadcastId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'})
};
fetch('https://platform.trylath.com/email/broadcast/get', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://platform.trylath.com/email/broadcast/get"
payload = { "broadcastId": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://platform.trylath.com/email/broadcast/get"
payload := strings.NewReader("{\n \"broadcastId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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))
}{
"activityId": "<string>",
"result": {
"broadcast": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"template": "<string>",
"topic": "<string>",
"segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"variables": "<unknown>",
"scheduledAt": "2023-11-07T05:31:56Z",
"status": "draft",
"counts": null,
"sentAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"from": "<string>",
"subject": "<string>"
},
"readiness": {
"ok": true,
"problems": [
{
"code": "<string>",
"message": "<string>",
"fix": "<string>"
}
]
},
"progress": {
"inFlight": 0,
"done": true
}
}
}Authorizations
A Lath API key: lath_live_sk… or lath_test_sk… on a server, lath_live_pk… or lath_test_pk… in a browser.
Body
application/json
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Last modified on September 13, 2026
Was this page helpful?

