audience.optin.get
curl --request POST \
--url https://platform.trylath.com/audience/optin/get \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"address": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({address: '<string>'})
};
fetch('https://platform.trylath.com/audience/optin/get', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://platform.trylath.com/audience/optin/get"
payload = { "address": "<string>" }
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/audience/optin/get"
payload := strings.NewReader("{\n \"address\": \"<string>\"\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": {
"channel": "email",
"address": "<string>",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"transactional": {
"allowed": true
},
"marketing": "<unknown>",
"consents": [
"<unknown>"
],
"suppressions": [
"<unknown>"
]
}
}audience.optin.get
The complete opt-in record for one address: every consent grant and revocation with the wording shown, the source and the time; the suppression history including STOP, START, bounces and complaints; and whether a message may be sent right now for each topic, transactional and marketing. Keyed by the address rather than by a contact, because that is what a carrier audit or a complaint names — and an address with no contact still has a history worth showing.
POST
/
audience
/
optin
/
get
audience.optin.get
curl --request POST \
--url https://platform.trylath.com/audience/optin/get \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"address": "<string>"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({address: '<string>'})
};
fetch('https://platform.trylath.com/audience/optin/get', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://platform.trylath.com/audience/optin/get"
payload = { "address": "<string>" }
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/audience/optin/get"
payload := strings.NewReader("{\n \"address\": \"<string>\"\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": {
"channel": "email",
"address": "<string>",
"contactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"transactional": {
"allowed": true
},
"marketing": "<unknown>",
"consents": [
"<unknown>"
],
"suppressions": [
"<unknown>"
]
}
}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
Last modified on September 13, 2026
Was this page helpful?

