curl --request GET \
--url https://brew.new/api/v1/emails/{emailId}/inbox-placement-tests \
--header 'Authorization: Bearer <token>'import requests
url = "https://brew.new/api/v1/emails/{emailId}/inbox-placement-tests"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://brew.new/api/v1/emails/{emailId}/inbox-placement-tests', 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://brew.new/api/v1/emails/{emailId}/inbox-placement-tests",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://brew.new/api/v1/emails/{emailId}/inbox-placement-tests"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://brew.new/api/v1/emails/{emailId}/inbox-placement-tests")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://brew.new/api/v1/emails/{emailId}/inbox-placement-tests")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"testId": "ibp_2f1c9d8a-4e77-4b0e-9a1c-6d5e2f0b7c31",
"emailId": "eml_welcome",
"status": "completed",
"domainId": "k57e9m3q1w8r",
"seedCount": 42,
"results": {
"overall": {
"provider": "all",
"total": 42,
"inbox": 38,
"spam": 3,
"missing": 1,
"pending": 0,
"categories": {
"inbox": 34,
"promotions": 4,
"spam": 3
}
},
"byProvider": [
{
"provider": "gmail.com",
"total": 4,
"inbox": 4,
"spam": 0,
"missing": 0,
"pending": 0,
"categories": {
"inbox": 3,
"promotions": 1
}
}
],
"authentication": {
"spf": "pass",
"dkim": "pass",
"dmarc": "pass"
},
"spamFilter": {
"flagged": false,
"score": -0.2,
"threshold": 5,
"rules": [
{
"name": "DKIM_SIGNED",
"score": 0.1,
"description": "Message has a DKIM signature"
}
]
}
},
"createdAt": "2026-07-13T17:00:06.675Z",
"updatedAt": "2026-07-13T17:00:06.675Z"
}{
"error": {
"code": "INVALID_API_KEY",
"type": "authentication_error",
"message": "The provided API key is invalid.",
"suggestion": "Check the API key format and retry with a valid active key.",
"docs": "https://docs.brew.new/api-reference/api/authentication"
}
}{
"error": {
"code": "INSUFFICIENT_PERMISSIONS",
"type": "authorization_error",
"message": "The caller does not have the required permission.",
"suggestion": "Use an API key or session with the required permission.",
"docs": "https://docs.brew.new/api-reference/api/authentication",
"param": "emails"
}
}{
"error": {
"code": "EMAIL_NOT_FOUND",
"type": "not_found",
"message": "No email exists with id 'eml_welcome'.",
"suggestion": "Verify the testId returned by the create endpoint.",
"docs": "https://docs.brew.new/api-reference/api/errors"
}
}{
"error": {
"code": "RATE_LIMITED",
"type": "rate_limit",
"message": "Too many requests.",
"suggestion": "Wait for the retry window before sending another request.",
"docs": "https://docs.brew.new/api-reference/api/rate-limits",
"retryAfter": 42
}
}{
"error": {
"code": "INTERNAL_ERROR",
"type": "internal_error",
"message": "An unexpected error occurred.",
"suggestion": "Retry the request. If it keeps failing, contact support.",
"docs": "https://docs.brew.new/api-reference/api/errors"
}
}Get inbox placement results
With testId: the current status + placement of ONE test — while status is collecting, this live-refreshes from the provider (re-poll every ~30s until completed) and returns per-provider inbox/spam/missing tallies with folder/tab categories and ACTUAL folders (e.g. Gmail Promotions, Yahoo bulk, gmx spamverdacht), each provider’s OWN SPF/DKIM/DMARC verdicts (byProvider[].authentication), Microsoft’s filter telemetry (microsoftFilter — SCL >= 5 lands in Junk), a spoofing check (spoofingDetected), header checks (headers — one-click unsubscribe, plain-text part), a spamFilter content verdict with the triggered rules, and a diagnosis array of per-provider findings with concrete remediation. WITHOUT testId: lists the design’s recent tests (lean rows, persisted snapshots — poll a testId to refresh) for comparing subject/preview/version variants side by side. FREE.
curl --request GET \
--url https://brew.new/api/v1/emails/{emailId}/inbox-placement-tests \
--header 'Authorization: Bearer <token>'import requests
url = "https://brew.new/api/v1/emails/{emailId}/inbox-placement-tests"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://brew.new/api/v1/emails/{emailId}/inbox-placement-tests', 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://brew.new/api/v1/emails/{emailId}/inbox-placement-tests",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://brew.new/api/v1/emails/{emailId}/inbox-placement-tests"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://brew.new/api/v1/emails/{emailId}/inbox-placement-tests")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://brew.new/api/v1/emails/{emailId}/inbox-placement-tests")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"testId": "ibp_2f1c9d8a-4e77-4b0e-9a1c-6d5e2f0b7c31",
"emailId": "eml_welcome",
"status": "completed",
"domainId": "k57e9m3q1w8r",
"seedCount": 42,
"results": {
"overall": {
"provider": "all",
"total": 42,
"inbox": 38,
"spam": 3,
"missing": 1,
"pending": 0,
"categories": {
"inbox": 34,
"promotions": 4,
"spam": 3
}
},
"byProvider": [
{
"provider": "gmail.com",
"total": 4,
"inbox": 4,
"spam": 0,
"missing": 0,
"pending": 0,
"categories": {
"inbox": 3,
"promotions": 1
}
}
],
"authentication": {
"spf": "pass",
"dkim": "pass",
"dmarc": "pass"
},
"spamFilter": {
"flagged": false,
"score": -0.2,
"threshold": 5,
"rules": [
{
"name": "DKIM_SIGNED",
"score": 0.1,
"description": "Message has a DKIM signature"
}
]
}
},
"createdAt": "2026-07-13T17:00:06.675Z",
"updatedAt": "2026-07-13T17:00:06.675Z"
}{
"error": {
"code": "INVALID_API_KEY",
"type": "authentication_error",
"message": "The provided API key is invalid.",
"suggestion": "Check the API key format and retry with a valid active key.",
"docs": "https://docs.brew.new/api-reference/api/authentication"
}
}{
"error": {
"code": "INSUFFICIENT_PERMISSIONS",
"type": "authorization_error",
"message": "The caller does not have the required permission.",
"suggestion": "Use an API key or session with the required permission.",
"docs": "https://docs.brew.new/api-reference/api/authentication",
"param": "emails"
}
}{
"error": {
"code": "EMAIL_NOT_FOUND",
"type": "not_found",
"message": "No email exists with id 'eml_welcome'.",
"suggestion": "Verify the testId returned by the create endpoint.",
"docs": "https://docs.brew.new/api-reference/api/errors"
}
}{
"error": {
"code": "RATE_LIMITED",
"type": "rate_limit",
"message": "Too many requests.",
"suggestion": "Wait for the retry window before sending another request.",
"docs": "https://docs.brew.new/api-reference/api/rate-limits",
"retryAfter": 42
}
}{
"error": {
"code": "INTERNAL_ERROR",
"type": "internal_error",
"message": "An unexpected error occurred.",
"suggestion": "Retry the request. If it keeps failing, contact support.",
"docs": "https://docs.brew.new/api-reference/api/errors"
}
}Authorizations
Send your Brew API key as Authorization: Bearer brew_xxx.
Headers
The brand this request acts on. REQUIRED for organization-scoped credentials (otherwise 400 BRAND_ID_REQUIRED — there is no default brand); list ids with GET /v1/brands. Brand-scoped credentials may omit it, and sending a different brand returns 403 BRAND_SCOPE_MISMATCH. A brand outside your organization returns 404 BRAND_NOT_FOUND.
1 - 64Path Parameters
Design id returned by POST /v1/emails and listed by GET /v1/emails.
1 - 64"eml_2SmZOWV3ZQ7W5x6g3m4p"
Query Parameters
The test id returned by the create endpoint; omit to list the design's recent tests.
1 - 80"ibp_2f1c9d8a-4e77-4b0e-9a1c-6d5e2f0b7c31"
Response
With testId: the test resource. Without: { data: [lean test rows] }.
- Option 1
- Option 2
pending, sending, collecting, completed, partial, failed x >= 0Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?