Search email stop-list
curl --request POST \
--url https://app.gtm-api.com/email/v4/api/email-suppressions/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"filter": {
"sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"address": {
"eq": "<string>",
"in": [
"<string>"
]
},
"origin": {
"in": [],
"nin": []
},
"created_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
},
"deleted_at": {
"gte": "<string>",
"lte": "<string>",
"is_null": true
}
},
"include": [
"source_email_message"
],
"page_size": 250,
"cursor": "<string>"
}
'import requests
url = "https://app.gtm-api.com/email/v4/api/email-suppressions/search"
payload = {
"filter": {
"sid": {
"eq": "<string>",
"in": ["<string>"]
},
"address": {
"eq": "<string>",
"in": ["<string>"]
},
"origin": {
"in": [],
"nin": []
},
"created_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
},
"deleted_at": {
"gte": "<string>",
"lte": "<string>",
"is_null": True
}
},
"include": ["source_email_message"],
"page_size": 250,
"cursor": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Team-SID": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Team-SID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
filter: {
sid: {eq: '<string>', in: ['<string>']},
address: {eq: '<string>', in: ['<string>']},
origin: {in: [], nin: []},
created_at: {gte: '<string>', lte: '<string>', gt: '<string>', lt: '<string>'},
deleted_at: {gte: '<string>', lte: '<string>', is_null: true}
},
include: ['source_email_message'],
page_size: 250,
cursor: '<string>'
})
};
fetch('https://app.gtm-api.com/email/v4/api/email-suppressions/search', 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://app.gtm-api.com/email/v4/api/email-suppressions/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filter' => [
'sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'address' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'origin' => [
'in' => [
],
'nin' => [
]
],
'created_at' => [
'gte' => '<string>',
'lte' => '<string>',
'gt' => '<string>',
'lt' => '<string>'
],
'deleted_at' => [
'gte' => '<string>',
'lte' => '<string>',
'is_null' => true
]
],
'include' => [
'source_email_message'
],
'page_size' => 250,
'cursor' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Team-SID: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.gtm-api.com/email/v4/api/email-suppressions/search"
payload := strings.NewReader("{\n \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"address\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"origin\": {\n \"in\": [],\n \"nin\": []\n },\n \"created_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"deleted_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n }\n },\n \"include\": [\n \"source_email_message\"\n ],\n \"page_size\": 250,\n \"cursor\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Team-SID", "<api-key>")
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))
}HttpResponse<String> response = Unirest.post("https://app.gtm-api.com/email/v4/api/email-suppressions/search")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"address\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"origin\": {\n \"in\": [],\n \"nin\": []\n },\n \"created_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"deleted_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n }\n },\n \"include\": [\n \"source_email_message\"\n ],\n \"page_size\": 250,\n \"cursor\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.gtm-api.com/email/v4/api/email-suppressions/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"address\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"origin\": {\n \"in\": [],\n \"nin\": []\n },\n \"created_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"deleted_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n }\n },\n \"include\": [\n \"source_email_message\"\n ],\n \"page_size\": 250,\n \"cursor\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "search",
"items": [
{
"item": {
"sid": "<string>",
"team_sid": "<string>",
"address": "<string>",
"origin": "manual",
"reason": "<string>",
"source_email_message_sid": "<string>",
"created_by": {
"actor_type": "user",
"actor_sid": "<string>",
"team_sid": "<string>",
"permissions": {},
"actor_name": "<string>",
"oauth_client_sid": "<string>",
"reason": "<string>",
"cluster_id": 123,
"trace_id": "<string>"
},
"deleted_by": {
"actor_type": "user",
"actor_sid": "<string>",
"team_sid": "<string>",
"permissions": {},
"actor_name": "<string>",
"oauth_client_sid": "<string>",
"reason": "<string>",
"cluster_id": 123,
"trace_id": "<string>"
},
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>"
},
"included": {
"source_email_message": {
"sid": "<string>",
"team_sid": "<string>",
"email_account_sid": "<string>",
"email_thread_sid": "<string>",
"internet_message_id": "<string>",
"provider_message_id": "<string>",
"direction": "inbound",
"status": "received",
"kind": "regular",
"in_reply_to_email_message_sid": "<string>",
"bounce_type": "hard",
"bounce_code": "<string>",
"bounce_diagnostic": "<string>",
"from": {
"email": "<string>",
"display_name": "<string>"
},
"to": [
{
"email": "<string>",
"display_name": "<string>"
}
],
"cc": [
{
"email": "<string>",
"display_name": "<string>"
}
],
"bcc": [
{
"email": "<string>",
"display_name": "<string>"
}
],
"reply_to": [
{
"email": "<string>",
"display_name": "<string>"
}
],
"subject": "<string>",
"snippet": "<string>",
"is_body_synced": true,
"attachments": [
{
"id": "<string>",
"name": "<string>",
"mime": "<string>",
"size": 1,
"content_id": "<string>",
"is_inline": true
}
],
"has_attachments": true,
"email_folder_sids": [
"<string>"
],
"folder_role": "inbox",
"is_read": true,
"client_reference": "<string>",
"first_opened_at": "<string>",
"opens_count": 123,
"first_clicked_at": "<string>",
"clicks_count": 123,
"unsubscribed_at": "<string>",
"sent_at": "<string>",
"scheduled_at": "<string>",
"created_by": {
"actor_type": "user",
"actor_sid": "<string>",
"team_sid": "<string>",
"permissions": {},
"actor_name": "<string>",
"oauth_client_sid": "<string>",
"reason": "<string>",
"cluster_id": 123,
"trace_id": "<string>"
},
"body_html": "<string>",
"body_text": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
}
],
"body_html_sanitized": "<string>",
"body_text_unquoted": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"is_flagged": true,
"is_answered": true,
"deleted_at": "<string>"
}
}
}
],
"pagination": {
"next_cursor": "<string>",
"has_more": true,
"total_count": 123
},
"applied_filters": {},
"includes": [
"<string>"
],
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
},
"counts": {
"total_count": 123,
"groups": {
"origin": {}
}
}
}email_suppressions
Search email stop-list
List the workspace’s stop-list: the addresses no mailbox of the team sends to, each with its origin (manual, bounce, unsubscribe, complaint) and reason. Every send checks the list by itself, so use this to see why someone was skipped, to check one address (filter address eq, page_size 1), to probe a list before a send (address in) and to audit lifts (a deleted_at range; deleted_by is who lifted). include source_email_message brings the message behind an automatic row. Not for why an address bounced (search_email_bounce_log). Requires can_view_email_suppressions.
Contract:
- MCP tool
search_email_suppressions, registry packagemcp.email/email_suppressions, mountemail.deliverability. - Operation
search, response envelopesearch. - Flags: read only.
POST
/
api
/
email-suppressions
/
search
Search email stop-list
curl --request POST \
--url https://app.gtm-api.com/email/v4/api/email-suppressions/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"filter": {
"sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"address": {
"eq": "<string>",
"in": [
"<string>"
]
},
"origin": {
"in": [],
"nin": []
},
"created_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
},
"deleted_at": {
"gte": "<string>",
"lte": "<string>",
"is_null": true
}
},
"include": [
"source_email_message"
],
"page_size": 250,
"cursor": "<string>"
}
'import requests
url = "https://app.gtm-api.com/email/v4/api/email-suppressions/search"
payload = {
"filter": {
"sid": {
"eq": "<string>",
"in": ["<string>"]
},
"address": {
"eq": "<string>",
"in": ["<string>"]
},
"origin": {
"in": [],
"nin": []
},
"created_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
},
"deleted_at": {
"gte": "<string>",
"lte": "<string>",
"is_null": True
}
},
"include": ["source_email_message"],
"page_size": 250,
"cursor": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Team-SID": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Team-SID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
filter: {
sid: {eq: '<string>', in: ['<string>']},
address: {eq: '<string>', in: ['<string>']},
origin: {in: [], nin: []},
created_at: {gte: '<string>', lte: '<string>', gt: '<string>', lt: '<string>'},
deleted_at: {gte: '<string>', lte: '<string>', is_null: true}
},
include: ['source_email_message'],
page_size: 250,
cursor: '<string>'
})
};
fetch('https://app.gtm-api.com/email/v4/api/email-suppressions/search', 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://app.gtm-api.com/email/v4/api/email-suppressions/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filter' => [
'sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'address' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'origin' => [
'in' => [
],
'nin' => [
]
],
'created_at' => [
'gte' => '<string>',
'lte' => '<string>',
'gt' => '<string>',
'lt' => '<string>'
],
'deleted_at' => [
'gte' => '<string>',
'lte' => '<string>',
'is_null' => true
]
],
'include' => [
'source_email_message'
],
'page_size' => 250,
'cursor' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Team-SID: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.gtm-api.com/email/v4/api/email-suppressions/search"
payload := strings.NewReader("{\n \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"address\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"origin\": {\n \"in\": [],\n \"nin\": []\n },\n \"created_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"deleted_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n }\n },\n \"include\": [\n \"source_email_message\"\n ],\n \"page_size\": 250,\n \"cursor\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Team-SID", "<api-key>")
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))
}HttpResponse<String> response = Unirest.post("https://app.gtm-api.com/email/v4/api/email-suppressions/search")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"address\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"origin\": {\n \"in\": [],\n \"nin\": []\n },\n \"created_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"deleted_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n }\n },\n \"include\": [\n \"source_email_message\"\n ],\n \"page_size\": 250,\n \"cursor\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.gtm-api.com/email/v4/api/email-suppressions/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"address\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"origin\": {\n \"in\": [],\n \"nin\": []\n },\n \"created_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"deleted_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n }\n },\n \"include\": [\n \"source_email_message\"\n ],\n \"page_size\": 250,\n \"cursor\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "search",
"items": [
{
"item": {
"sid": "<string>",
"team_sid": "<string>",
"address": "<string>",
"origin": "manual",
"reason": "<string>",
"source_email_message_sid": "<string>",
"created_by": {
"actor_type": "user",
"actor_sid": "<string>",
"team_sid": "<string>",
"permissions": {},
"actor_name": "<string>",
"oauth_client_sid": "<string>",
"reason": "<string>",
"cluster_id": 123,
"trace_id": "<string>"
},
"deleted_by": {
"actor_type": "user",
"actor_sid": "<string>",
"team_sid": "<string>",
"permissions": {},
"actor_name": "<string>",
"oauth_client_sid": "<string>",
"reason": "<string>",
"cluster_id": 123,
"trace_id": "<string>"
},
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>"
},
"included": {
"source_email_message": {
"sid": "<string>",
"team_sid": "<string>",
"email_account_sid": "<string>",
"email_thread_sid": "<string>",
"internet_message_id": "<string>",
"provider_message_id": "<string>",
"direction": "inbound",
"status": "received",
"kind": "regular",
"in_reply_to_email_message_sid": "<string>",
"bounce_type": "hard",
"bounce_code": "<string>",
"bounce_diagnostic": "<string>",
"from": {
"email": "<string>",
"display_name": "<string>"
},
"to": [
{
"email": "<string>",
"display_name": "<string>"
}
],
"cc": [
{
"email": "<string>",
"display_name": "<string>"
}
],
"bcc": [
{
"email": "<string>",
"display_name": "<string>"
}
],
"reply_to": [
{
"email": "<string>",
"display_name": "<string>"
}
],
"subject": "<string>",
"snippet": "<string>",
"is_body_synced": true,
"attachments": [
{
"id": "<string>",
"name": "<string>",
"mime": "<string>",
"size": 1,
"content_id": "<string>",
"is_inline": true
}
],
"has_attachments": true,
"email_folder_sids": [
"<string>"
],
"folder_role": "inbox",
"is_read": true,
"client_reference": "<string>",
"first_opened_at": "<string>",
"opens_count": 123,
"first_clicked_at": "<string>",
"clicks_count": 123,
"unsubscribed_at": "<string>",
"sent_at": "<string>",
"scheduled_at": "<string>",
"created_by": {
"actor_type": "user",
"actor_sid": "<string>",
"team_sid": "<string>",
"permissions": {},
"actor_name": "<string>",
"oauth_client_sid": "<string>",
"reason": "<string>",
"cluster_id": 123,
"trace_id": "<string>"
},
"body_html": "<string>",
"body_text": "<string>",
"headers": [
{
"name": "<string>",
"value": "<string>"
}
],
"body_html_sanitized": "<string>",
"body_text_unquoted": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"is_flagged": true,
"is_answered": true,
"deleted_at": "<string>"
}
}
}
],
"pagination": {
"next_cursor": "<string>",
"has_more": true,
"total_count": 123
},
"applied_filters": {},
"includes": [
"<string>"
],
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
},
"counts": {
"total_count": 123,
"groups": {
"origin": {}
}
}
}Authorizations
Headers
Body
application/json
Request body of search_email_suppressions.
Response
search success envelope.