ZapSMTP / Docs / Inbox placementResponse
Retrieve a placement test
GET/v1/placement-tests/{id}
Retrieve a placement test with where each copy landed.
Requires a full-access key.
ZapSMTP then reads each seed mailbox (Gmail, Outlook, Yahoo and others) and records where the copy landed: inbox, a Gmail tab (promotions, social, updates, forums), spam, or missing once the test ends (15 minutes after a send). auth is the provider's own SPF, DKIM and DMARC verdict.
status is running until every seed has an answer or the test ends, then done. summary.inbox_rate = inbox (any tab) / seeds with an answer.
Path parameters
idstringrequired- The test id.
Errors
not_foundHTTP 404- placement test not found
curl 'https://api.zapsmtp.com/v1/placement-tests/019a1f2e-7c3b-7d41-9a52-0c4b8e6f1a23' \
-H "Authorization: Bearer $ZAP_API_KEY"const res = await fetch('https://api.zapsmtp.com/v1/placement-tests/019a1f2e-7c3b-7d41-9a52-0c4b8e6f1a23', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.ZAP_API_KEY}`,
},
});
// 204 No Content (e.g. a delete) has no body
const data = res.status === 204 ? null : await res.json();
if (!res.ok) throw new Error(`${data.name}: ${data.message}`);
console.log(data);import os
import requests
res = requests.get(
"https://api.zapsmtp.com/v1/placement-tests/019a1f2e-7c3b-7d41-9a52-0c4b8e6f1a23",
headers={"Authorization": f"Bearer {os.environ['ZAP_API_KEY']}"},
timeout=30,
)
res.raise_for_status()
print(res.json() if res.status_code != 204 else "deleted")<?php
$ch = curl_init('https://api.zapsmtp.com/v1/placement-tests/019a1f2e-7c3b-7d41-9a52-0c4b8e6f1a23');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('ZAP_API_KEY'),
],
]);
$data = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
if ($status >= 400) {
throw new RuntimeException($data['message']);
}
print_r($data);package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, err := http.NewRequest(
"GET",
"https://api.zapsmtp.com/v1/placement-tests/019a1f2e-7c3b-7d41-9a52-0c4b8e6f1a23",
nil,
)
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer "+os.Getenv("ZAP_API_KEY"))
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(res.Status, string(out))
}require 'net/http'
require 'json'
uri = URI('https://api.zapsmtp.com/v1/placement-tests/019a1f2e-7c3b-7d41-9a52-0c4b8e6f1a23')
req = Net::HTTP::Get.new(uri)
req['Authorization'] = "Bearer #{ENV.fetch('ZAP_API_KEY')}"
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
puts res.code, (JSON.parse(res.body) unless res.body.to_s.empty?)import java.net.URI;
import java.net.http.*;
public class ZapRequest {
public static void main(String[] args) throws Exception {
var request = HttpRequest.newBuilder(URI.create("https://api.zapsmtp.com/v1/placement-tests/019a1f2e-7c3b-7d41-9a52-0c4b8e6f1a23"))
.header("Authorization", "Bearer " + System.getenv("ZAP_API_KEY"))
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
var response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}using System.Net.Http.Headers;
using System.Text;
using var http = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.zapsmtp.com/v1/placement-tests/019a1f2e-7c3b-7d41-9a52-0c4b8e6f1a23");
request.Headers.Authorization = new AuthenticationHeaderValue(
"Bearer", Environment.GetEnvironmentVariable("ZAP_API_KEY"));
var response = await http.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");Set
ZAP_API_KEY in your environment.Response 200 OK
{
"object": "placement_test",
"id": "019a2b10-1a2b-7c3d-8e4f-5a6b7c8d9e0f",
"mode": "send",
"token": "zp-4f9k2m8q1x7c3v5b",
"from": "News <news@example.com>",
"subject": "November offers",
"status": "done",
"created_at": "2026-11-02T10:00:00Z",
"ends_at": "2026-11-02T10:15:00Z",
"finished_at": "2026-11-02T10:02:30Z",
"results": [
{
"provider": "gmail",
"address": "seed1@gmail.com",
"email_id": "019a2b10-5c6d-7e8f-9a0b-1c2d3e4f5a6b",
"placement": "promotions",
"folder": "INBOX",
"received_at": "2026-11-02T10:00:41Z",
"auth": {
"spf": "pass",
"dkim": "pass",
"dmarc": "pass"
}
},
{
"provider": "outlook",
"address": "seed1@outlook.com",
"email_id": "019a2b10-5c6d-7e8f-9a0b-1c2d3e4f5a6b",
"placement": "inbox",
"folder": "INBOX",
"received_at": "2026-11-02T10:00:41Z",
"auth": {
"spf": "pass",
"dkim": "pass",
"dmarc": "pass"
}
},
{
"provider": "yahoo",
"address": "seed1@yahoo.com",
"email_id": "019a2b10-5c6d-7e8f-9a0b-1c2d3e4f5a6b",
"placement": "spam",
"folder": "Bulk",
"received_at": "2026-11-02T10:00:41Z",
"auth": {
"spf": "pass",
"dkim": "pass",
"dmarc": "pass"
}
}
],
"summary": {
"total": 3,
"inbox": 2,
"primary": 1,
"promotions": 1,
"social": 0,
"updates": 0,
"forums": 0,
"spam": 1,
"missing": 0,
"pending": 0,
"inbox_rate": 0.666
}
}